| Interface | osid.authentication.keys.KeySearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description | 
                 
  | ||
| Method | searchAmongKeys | ||
| Description | 
                     Execute this search among the given list of keys.  | ||
| Parameters | osid.id.IdList | agentIds | list of agents | 
| Errors | NULL_ARGUMENT |  agentIds  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderKeyResults | ||
| Description | 
                     Specify an ordering to the search results.  | ||
| Parameters | osid.authentication.keys.KeySearchOrder | keySearchOrder | key search order | 
| Errors | NULL_ARGUMENT |  keySearchOrder  is  null   |                 |
| UNSUPPORTED |  keySearchOrder  is not of this service  |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getKeySearchRecord | ||
| Description | 
                     Gets the record corresponding to the given key search 
                    record   | ||
| Parameters | osid.type.Type | keySearchRecordType | a key search record type | 
| Return | osid.authentication.keys.records.KeySearchRecord | the key search record | |
| Errors | NULL_ARGUMENT |  keySearchRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(keySearchRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |