Interface | osid.hold.IssueSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByBureau | ||
Description |
Orders the results by resource. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBureauSearchOrder | ||
Description |
Tests if a resource search order is available. | ||
Return | boolean | true if a resource search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBureauSearchOrder | ||
Description |
Gets the resource search order. | ||
Return | osid.resource.ResourceSearchOrder | the resource search order | |
Errors | ILLEGAL_STATE | supportsResourceSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getIssueSearchOrderRecord | ||
Description |
Gets the issue search order record corresponding to the
given issue record | ||
Parameters | osid.type.Type | issueRecordType | an issue record type |
Return | osid.hold.records.IssueSearchOrderRecord | the issue search order record | |
Errors | NULL_ARGUMENT | issueRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(issueRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |