Interface | osid.provisioning.ProvisionReturnSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByReturnDate | ||
Description |
Orders the results by the return date. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByReturner | ||
Description |
Orders the results by the returner. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsReturnerSearchOrder | ||
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 | getReturnerSearchOrder | ||
Description |
Gets the resource search order. | ||
Return | osid.resource.ResourceSearchOrder | the resource search order | |
Errors | ILLEGAL_STATE | supportsReturnerSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByReturningAgent | ||
Description |
Orders the results by the returning agent. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsReturningAgentSearchOrder | ||
Description |
Tests if an agent search order is available. | ||
Return | boolean | true if an agent search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getReturningAgentSearchOrder | ||
Description |
Gets the agent search order. | ||
Return | osid.authentication.AgentSearchOrder | the agent search order | |
Errors | ILLEGAL_STATE | supportsReturningAgentSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionReturnSearchOrderRecord | ||
Description |
Gets the provision return search order record
corresponding to the given provision return record | ||
Parameters | osid.type.Type | provisionReturnRecordType | a provision return record type |
Return | osid.provisioning.records.ProvisionReturnSearchOrderRecord | the provision return search order record | |
Errors | NULL_ARGUMENT | provisionReturnRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(provisionReturnRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |