Interface | osid.authentication.keys.KeySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. This example fetches all keys and orders them by the agent display name. KeySearch ks = session.getKeySearch(); AgentSearch as = ks.getAgentSearch(); as.orderByDisplayName(); KeyQuery keyQueries[1]; keyQueries[0] = session.getKeyQuery(); AgentQuery agQueries[1]; qgQueries[1].matchDisplayName("*", true); KeySearchResults results = session.getKeysBySearch(keyQueries, ks); KeyList kl = results.getKeys(); | ||
Method | getKeys | ||
Description |
Gets the key list resulting from the search. | ||
Return | osid.authentication.keys.KeyList | the key list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getKeyQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.authentication.keys.KeyQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getKeySearchResultsRecord | ||
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.KeySearchResultsRecord | the key search results 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. |