public interface KeySearchSession extends KeyQuerySession
This session provides methods for searching Keys.
The
search query is constructed using the KeyQuery.
The key
record Type
also specifies the record for the key query.
getKeysByQuery()
is the basic search method and returns
a list of Keys.
A more advanced search may be performed
with getKeysBySearch().
It accepts an KeySearch
in addition to the query for the purpose of specifying additional
options affecting the entire search, such as ordering.
getKeysBySearch()
returns a KeySearchResult
that
can be used to access the resulting KeyList
or be used to
perform a search within the result set through KeySearch.
This session defines views that offer differing behaviors for searching.
Keys may have a query record indicated by their respective record types. The query record is accessed via the KeyQuery.
Modifier and Type | Method and Description |
---|---|
KeyQuery |
getKeyQueryFromInspector(KeyQueryInspector keyQueryInspector)
Gets a key query from an inspector.
|
KeySearchResults |
getKeysBySearch(KeyQuery keyQuery,
KeySearch keySearch)
Gets a list of
Keys matching the given search. |
KeySearch |
getKeySearch()
Gets a key query.
|
KeySearchOrder |
getKeySearchOrder()
Gets a key search order.
|
canSearchKeys, getAgency, getAgencyId, getKeyQuery, getKeysByQuery, useFederatedAgencyView, useIsolatedAgencyView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
KeySearch getKeySearch()
mandatory
- This method must be implemented. KeySearchOrder getKeySearchOrder()
KeySearchOrder
is supplied
to a KeySearch
to specify the ordering of results.mandatory
- This method must be implemented. KeySearchResults getKeysBySearch(KeyQuery keyQuery, KeySearch keySearch) throws OperationFailedException, PermissionDeniedException
Keys
matching the given search.keyQuery
- the key querykeySearch
- the key searchNullArgumentException
- keyQuery
or
keySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- keySearch
or a
keyQuery
is not of this servicemandatory
- This method must be implemented. KeyQuery getKeyQueryFromInspector(KeyQueryInspector keyQueryInspector)
KeySearchResults.
keyQueryInspector
- a query inspectorNullArgumentException
- keyQueryInspector
is null
UnsupportedException
- keyQueryInspector
is not of this servicemandatory
- This method must be implemented.