Interface | osid.configuration.ParameterSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRuleSearchOrder | ||
Description |
This interface specifies options for ordering search results. | ||
Method | orderByValueSyntax | ||
Description |
Specifies a preference for ordering the results by the value syntax and object type. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByValuesShuffled | ||
Description |
Specifies a preference for ordering the results by the shuffle flag. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getParameterSearchOrderRecord | ||
Description |
Gets the parameter search order record corresponding to
the given parameter record | ||
Parameters | osid.type.Type | parameterRecordType | a parameter record type |
Return | osid.configuration.records.ParameterSearchOrderRecord | the parameter search order record | |
Errors | NULL_ARGUMENT | parameterRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(parameterRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |