public interface AntimatroidSearchSession extends AntimatroidQuerySession
This session provides methods for searching among Antimatroid
objects. The search query is constructed using the
AntimatroidQuery.
getAntimatroidsByQuery()
is the basic search method and
returns a list of Antimatroids.
A more advanced search may
be performed with getAntimatroidsBySearch().
It accepts an
AntimatroidSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getAntimatroidsBySearch()
returns an
AntimatroidSearchResults
that can be used to access the resulting
AntimatroidList
or be used to perform a search within the
result set through AntimatroidSearch.
Antimatroids may have a query record indicated by their respective
record types. The query record is accessed via the
AntimatroidQuery.
Modifier and Type | Method and Description |
---|---|
AntimatroidQuery |
getAntimatroidQueryFromInspector(AntimatroidQueryInspector antimatroidQueryInspector)
Gets an antimatroid query from an inspector.
|
AntimatroidSearchResults |
getAntimatroidsBySearch(AntimatroidQuery antimatroidQuery,
AntimatroidSearch antimatroidSearch)
Gets the search results matching the given search query using the
given search.
|
AntimatroidSearch |
getAntimatroidSearch()
Gets an antimatroid search.
|
AntimatroidSearchOrder |
getAntimatroidSearchOrder()
Gets an antimatroid search order.
|
canSearchAntimatroids, getAntimatroidQuery, getAntimatroidsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AntimatroidSearch getAntimatroidSearch()
mandatory
- This method must be implemented. AntimatroidSearchOrder getAntimatroidSearchOrder()
AntimatroidSearchOrder
is supplied to an AntimatroidSearch
to specify
the ordering of results.mandatory
- This method must be implemented. AntimatroidSearchResults getAntimatroidsBySearch(AntimatroidQuery antimatroidQuery, AntimatroidSearch antimatroidSearch) throws OperationFailedException, PermissionDeniedException
antimatroidQuery
- the antimatroid queryantimatroidSearch
- the antimatroid searchNullArgumentException
- antimatroidQuery
or antimatroidSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- antimatroidQuery
or antimatroidSearch
is not of this servicemandatory
- This method must be implemented. AntimatroidQuery getAntimatroidQueryFromInspector(AntimatroidQueryInspector antimatroidQueryInspector)
AntimatroidSearchResults.
antimatroidQueryInspector
- an antimatroid query inspectorNullArgumentException
-
antimatroidQueryInspector
is null
UnsupportedException
- antimatroidQueryInspector
is not of this servicemandatory
- This method must be implemented.