public interface QualifierSearchSession extends QualifierQuerySession
This session provides methods for searching among Qualifier
objects. The search query is constructed using the
QualifierQuery.
If more than one search element is specified
within a single QualifierQuery,
these elements form a
boolean AND.
getQualifiersByQuery()
is the basic search method and
returns a list of Qualifiers.
A more advanced search may be
performed with getQualifiersBySearch().
It accepts a
QualifierSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getQualifiersBySearch()
returns a
QualifierSearchResults
that can be used to access the resulting
QualifierList
or be used to perform a search within the
result set through QualifierSearch.
This session defines views that offer differing behaviors for searching.
Qualifiers may have a query record indicated by their respective
record types. The query record is accessed via the QualifierQuery.
Modifier and Type | Method and Description |
---|---|
QualifierQuery |
getQualifierQueryFromInspector(QualifierQueryInspector qualifierQueryInspector)
Gets a qualifier query from an inspector.
|
QualifierSearchResults |
getQualifiersBySearch(QualifierQuery qualifierQuery,
QualifierSearch qualifierSearch)
Gets the search results matching the given search query using the
given search.
|
QualifierSearch |
getQualifierSearch()
Gets a qualifier search.
|
QualifierSearchOrder |
getQualifierSearchOrder()
Gets a qualifier search order.
|
canSearchQualifiers, getQualifierQuery, getQualifiersByQuery, getVault, getVaultId, useFederatedVaultView, useIsolatedVaultView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
QualifierSearch getQualifierSearch()
mandatory
- This method must be implemented. QualifierSearchOrder getQualifierSearchOrder()
QualifierSearchOrder
is supplied to a QualifierSearch
to specify the
ordering of results.mandatory
- This method must be implemented. QualifierSearchResults getQualifiersBySearch(QualifierQuery qualifierQuery, QualifierSearch qualifierSearch) throws OperationFailedException, PermissionDeniedException
qualifierQuery
- the qualifier queryqualifierSearch
- the qualifier searchNullArgumentException
- qualifierQueriy
or qualifierSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- qualifierQuery
or
qualifierSearch
is not of this servicemandatory
- This method must be implemented. QualifierQuery getQualifierQueryFromInspector(QualifierQueryInspector qualifierQueryInspector)
QualifierSearchResults.
qualifierQueryInspector
- a qualifier query inspectorNullArgumentException
- qualifierQueryInspector
is null
UnsupportedException
- qualifierQueryInspector
is not of this servicemandatory
- This method must be implemented.