public interface CheckSearchSession extends CheckQuerySession
This session provides methods for searching among Check
objects. The search query is constructed using the CheckQuery.
getChecksByQuery()
is the basic search method and
returns a list of Checks.
A more advanced search may be
performed with getChecksBySearch().
It accepts a
CheckSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getChecksBySearch()
returns a CheckSearchResults
that can be used to access the resulting CheckList
or be
used to perform a search within the result set through CheckSearch.
This session defines views that offer differing behaviors for searching.
Checks may have a query record indicated by their respective record
types. The query record is accessed via the CheckQuery.
Modifier and Type | Method and Description |
---|---|
CheckQuery |
getCheckQueryFromInspector(CheckQueryInspector checkQueryInspector)
Gets a check query from an inspector.
|
CheckSearchResults |
getChecksBySearch(CheckQuery checkQuery,
CheckSearch checkSearch)
Gets the search results matching the given search query using the
given search.
|
CheckSearch |
getCheckSearch()
Gets a check search.
|
CheckSearchOrder |
getCheckSearchOrder()
Gets a check search order.
|
canSearchChecks, getCheckQuery, getChecksByQuery, getEngine, getEngineId, useFederatedEngineView, useIsolatedEngineView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CheckSearch getCheckSearch()
mandatory
- This method must be implemented. CheckSearchOrder getCheckSearchOrder()
CheckSearchOrder
is
supplied to a CheckSearch
to specify the ordering of
results.mandatory
- This method must be implemented. CheckSearchResults getChecksBySearch(CheckQuery checkQuery, CheckSearch checkSearch) throws OperationFailedException, PermissionDeniedException
checkQuery
- the check querycheckSearch
- the check searchNullArgumentException
- checkQuery
or
checkSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- checkQuery
or
checkSearch
is not of this servicemandatory
- This method must be implemented. CheckQuery getCheckQueryFromInspector(CheckQueryInspector checkQueryInspector)
CheckSearchResults.
checkQueryInspector
- a check query inspectorNullArgumentException
- checkQueryInspector
is null
UnsupportedException
- checkQueryInspector
is not of this servicemandatory
- This method must be implemented.