OSID Specifications
authentication keys package
Version 3.1.0
authentication keys package
Version 3.1.0
| Interface | osid.authentication.keys.KeySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Used By | osid.authentication.keys.KeySearchSession | ||
osid.authentication.keys.KeySmartAgencySession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | supportsAgentSearchOrder | ||
| Description |
Tests if an | ||
| Return | boolean | true if an agent search order interface is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentSearchOrder | ||
| Description |
Gets the agent search order. | ||
| Return | osid.authentication.AgentSearchOrder | the agent search order | |
| Errors | UNIMPLEMENTED | supportsAgentSearchOrder() is false | |
| Compliance | optional | This method must be implemented is supportsAgentSearchOrder()
is true. | |
| Method | getKeySearchOrderRecord | ||
| Description |
Gets the key search order record corresponding to the
given key record | ||
| Parameters | osid.type.Type | keyRecordType | a key record type |
| Return | osid.authentication.keys.records.KeySearchOrderRecord | the key search order record | |
| Errors | NULL_ARGUMENT | keyRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(keyRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |