PropertyHandle :: SetOrder - Set sort order

When there are different sort orders ( indexes ) supported for a collection one of those can be selected as current sort order. The sort order or index is selected by the key name that is associated with the index. Changing the sort order will reset the selection in the property handle and no instance is selected when the function returns.

When selecting a generic attribute index the attribute type (as e.g. language) can be passed to select the proper index. If no attribute type is passed it is evaluated from the generic attribute.

When not passing a sort key name the default index is set as current sort order. The default index is the identifying key index (when defined for the collection) or the first unique index in the list of available indexes . Passing "*" for the sort key name refreshes the sort order. This way it is possible to set the proper index for a generic attribute index or to reorganize a temporary index.When no index is defined for the passed key name or the attribute type is not defined the function returns an error ( YES ).