Interface | osid.authorization.FunctionSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRuleSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByQualifierHierarchy | ||
Description |
Specified a preference for ordering results by the qualifier hierarchy. | ||
Parameters | osid.SearchOrderStyle | style | the search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQualifierHierarchySearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a qualifier hierarchy search order interface is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQualifierHierarchySearchOrder | ||
Description |
Gets the search order interface for a qualifier hierarchy. | ||
Return | osid.hierarchy.HierarchySearchOrder | the hierarchy search order | |
Errors | UNIMPLEMENTED | supportsQualifierHierarchySearchOrder() is false
| |
Compliance | optional | This method must be implemented if
supportsQualifierHierarchySearchOrder() is true. | |
Method | getFunctionSearchOrderRecord | ||
Description |
Gets the function search order record corresponding to
the given function record | ||
Parameters | osid.type.Type | functionRecordType | a function record type |
Return | osid.authorization.records.FunctionSearchOrderRecord | the function search order record | |
Errors | NULL_ARGUMENT | functionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(functionRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |