| Interface | osid.authentication.AgentSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByResource | ||
| 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 | supportsResourceSearchOrder | ||
| Description |
Tests if a | ||
| Return | boolean | true if a resource search order interface is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceSearchOrder | ||
| Description |
Gets the resource search order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search odrer | |
| Errors | UNIMPLEMENTED | supportsResourceSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsResourceSearchOrder()
is true. | |
| Method | getAgentSearchOrderRecord | ||
| Description |
Gets the agent search order record corresponding to the
given agent record | ||
| Parameters | osid.type.Type | agentRecordType | an agent record type |
| Return | osid.authentication.records.AgentSearchOrderRecord | the agent search order record | |
| Errors | NULL_ARGUMENT | agentRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(agentRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |