public interface KeySearchResults extends OsidSearchResults
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();
Modifier and Type | Method and Description |
---|---|
KeyQueryInspector |
getKeyQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
KeyList |
getKeys()
Gets the key list resulting from the search.
|
KeySearchResultsRecord |
getKeySearchResultsRecord(Type keySearchRecordType)
Gets the record corresponding to the given key search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
KeyList getKeys()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. KeyQueryInspector getKeyQueryInspector()
mandatory
- This method must be implemented. KeySearchResultsRecord getKeySearchResultsRecord(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.