../E14406-01.epub /> ../E14406-01.mobi />

OMBRETRIEVE ALTERNATIVE_SORT_ORDER

Purpose

Retrieve details of an Alternative Sort Order.

Prerequisites

Should be in the context of a Business Definition Module or use the full path.

Syntax

retrieveAlternativeSortOrderCommand =  OMBRETRIEVE ALTERNATIVE_SORT_ORDER 
          "QUOTED_STRING" "retrieveAlternativeSortOrderClauseDetails"
     retrieveAlternativeSortOrderClauseDetails =  GET ( 
          "getPropertiesClauseforLOVandD2D" | "getReferenceIconSetClause" | ( 
          REF | REFERENCE ) DEFINING ITEM | ( REF | REFERENCE ) ORDERED ITEM | (
           REF | REFERENCE ) ITEMS | DEPENDENTS )
     getPropertiesClauseforLOVandD2D =  PROPERTIES "(" 
          "propertyNameListforLOVandD2D" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     propertyNameListforLOVandD2D =  ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) { 
          "," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }

Parameters

retrieveAlternativeSortOrderCommand

Retrieves the alternative sort order.

QUOTED_STRING

name of the alternative sort order.

retrieveAlternativeSortOrderClauseDetails

This clause retrieves the contents of an alternative sort order.

GET

This clause retrieves the following

REF DEFINING ITEM retrieves the Item that holds the individual values for this alternative sort order.

REF ORDERED ITEM retrieves the Item that holds the order of the values for this alternative sort order.

REF ITEMS retrieves the list of Items that use this alternative sort order.

DEPENDENTS retrieves a list of Item Folders that the alternative sort order depends on.

(This will return the Item Folder containing any Values and Order Items).

getPropertiesClauseforLOVandD2D

This clause gets the properties of the object.

getPropertiesClauseforLOVandD2D

Basic properties for ALTERNATIVE_SORT_ORDER: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the alternative sort order 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the alternative sort order 

Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the alternative sort order enables drilling between the item folders containing the items that use the alternative sort order 

Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: Any valid character string in supported character set.
Default: '100'
The number of rows to be fetched from the database at a time 

Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory 

Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested 

Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator 

Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden

getReferenceIconSetClause

Get specified Icon Set.

propertyNameListforLOVandD2D

This is the list of property names.

ALTERNATIVE_SORT_ORDER Object

Table 17-3 ALTERNATIVE_SORT_ORDER Object

Property Type Choices Min Max Default Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those objects marked as Deployable = true