public interface KeySearch extends OsidSearch
KeySearch
defines options for governing key searches.
Modifier and Type | Method and Description |
---|---|
KeySearchRecord |
getKeySearchRecord(Type keySearchRecordType)
Gets the record corresponding to the given key search record
Type. |
void |
orderKeyResults(KeySearchOrder keySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongKeys(IdList agentIds)
Execute this search among the given list of keys.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongKeys(IdList agentIds)
agentIds
- list of agentsNullArgumentException
- agentIds
is
null
mandatory
- This method must be implemented. void orderKeyResults(KeySearchOrder keySearchOrder)
keySearchOrder
- key search orderNullArgumentException
- keySearchOrder
is null
UnsupportedException
- keySearchOrder
is
not of this servicemandatory
- This method must be implemented. KeySearchRecord getKeySearchRecord(Type keySearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object implementing
the requested record.keySearchRecordType
- a key search record typeNullArgumentException
- keySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(keySearchRecordType)
is false
mandatory
- This method must be implemented.