public interface RequestSearchSession extends RequestQuerySession
This session provides methods for searching among Request
objects. The search query is constructed using the
RequestQuery.
getRequestsByQuery()
is the basic search method and
returns a list of Requests.
A more advanced search may be
performed with getRequestsBySearch().
It accepts a
RequestSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getRequestsBySearch()
returns a
RequestSearchResults
that can be used to access the resulting
RequestList
or be used to perform a search within the
result set through RequestSearch.
This session defines views that offer differing behaviors for searching.
Requests may have a query record indicated by their respective record
types. The query record is accessed via the RequestQuery.
Modifier and Type | Method and Description |
---|---|
RequestQuery |
getRequestQueryFromInspector(RequestQueryInspector requestQueryInspector)
Gets a request query from an inspector.
|
RequestSearchResults |
getRequestsBySearch(RequestQuery requestQuery,
RequestSearch requestSearch)
Gets the search results matching the given search query using the
given search.
|
RequestSearch |
getRequestSearch()
Gets a request search.
|
RequestSearchOrder |
getRequestSearchOrder()
Gets a request search order.
|
canSearchRequests, getDistributor, getDistributorId, getRequestQuery, getRequestsByQuery, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RequestSearch getRequestSearch()
mandatory
- This method must be implemented. RequestSearchOrder getRequestSearchOrder()
RequestSearchOrder
is
supplied to a RequestSearch
to specify the ordering of
results.mandatory
- This method must be implemented. RequestSearchResults getRequestsBySearch(RequestQuery requestQuery, RequestSearch requestSearch) throws OperationFailedException, PermissionDeniedException
requestQuery
- the request queryrequestSearch
- the request searchNullArgumentException
- requestQuery
or
requestSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- requestQuery
or
requestSearch
is not of this servicemandatory
- This method must be implemented. RequestQuery getRequestQueryFromInspector(RequestQueryInspector requestQueryInspector)
RequestSearchResults.
requestQueryInspector
- a request query inspectorNullArgumentException
- requestQueryInspector
is null
UnsupportedException
- requestQueryInspector
is not of this servicemandatory
- This method must be implemented.