Interface | osid.dictionary.EntrySearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
Description |
This interface specifies options for ordering search results. | ||
Method | orderByKeyType | ||
Description |
Specifies a preference for ordering the results by key type. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByKey | ||
Description |
Specifies a preference for ordering the results by key. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByValueType | ||
Description |
Specifies a preference for ordering the results by value type. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByValue | ||
Description |
Specifies a preference for ordering the results by value. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getEntrySearchOrderRecord | ||
Description |
Gets the entry search order record corresponding to the
given entry record | ||
Parameters | osid.type.Type | entryRecordType | an entry record type |
Return | osid.dictionary.records.EntrySearchOrderRecord | the entry search order record | |
Errors | NULL_ARGUMENT | entryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(entryRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |