Interface | osid.configuration.ValueSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidOperableSearchOrder | |||
osid.OsidSubjugateableSearchOrder | |||
Description |
This interface specifies options for ordering search results. | ||
Method | orderByPriority | ||
Description |
Specifies a preference for ordering the results by the value priority. | ||
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 the value. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsParameterSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a parameter search order interface is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getParameterSearchOrder | ||
Description |
Gets the parameter search order. | ||
Return | osid.configuration.ParameterSearchOrder | the parameter search order | |
Errors | UNIMPLEMENTED | supportsParameterSearchOrder() is false | |
Compliance | optional | This method must be implemented is supportsParameterSearchOrder()
is true. | |
Method | getValueSearchOrderRecord | ||
Description |
Gets the value search order record corresponding to the
given value record | ||
Parameters | osid.type.Type | valueRecordType | a value record type |
Return | osid.configuration.records.ValueSearchOrderRecord | the value search order record | |
Errors | NULL_ARGUMENT | valueRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(valueRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |