addMemberKeyWithSortOrder

addMemberKeyWithSortOrder(propertyName:    String;
                          descending:      Boolean;
                          caseInsensitive: Boolean;
                          sortOrder:       Integer) updating;

The addMemberKeyWithSortOrder method of the DynaDictionary class adds a member key specification to a dynamic dictionary.

If you require multiple keys, call the addMemberKeyWithSortOrder method to define each key in sequence. To signify that all keys have been defined, call the endKeys method.

Specify a key path by passing a key-path expression in the propertyName parameter; for example, "shipment.supplier.name". Set the descending parameter to true if you want keys sorted in descending order and the caseInsensitive parameter to true if case-sensitivity is not required.

For String and StringUtf8 keys, the sortOrder parameter specifies the locale identifier for the locale used to compare entries to determine the order of entries in the collection. This parameter is ignored for keys of other primitive types. A value of zero (0) indicates the binary sort order.

The following preconditions apply when adding keys to a dynamic dictionary.

• The collection is empty

• The member type has been specified by using the setMembership method

• The dictionary contains member key definition only

• The propertyName parameter represents a valid property for the member type

• The total concatenated key size does not exceed the current key size limit (512 character units)

The appropriate system exception is raised if any of these preconditions are violated.