public interface ResponseSearchSession extends ResponseQuerySession
This session provides methods for searching among Response
objects. The search query is constructed using the
ResponseQuery.
getResponsesByQuery()
is the basic search method and
returns a list of Responses.
A more advanced search may be
performed with getResponsesBySearch().
It accepts an
ResponseSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getResponsesBySearch()
returns an
ResponseSearchResults
that can be used to access the resulting
ResponseList
or be used to perform a search within the
result set through ResponseSearch.
This session defines views that offer differing behaviors for searching.
Responses may have a query record indicated by their respective record
types. The query record is accessed via the ResponseQuery.
Modifier and Type | Method and Description |
---|---|
ResponseQuery |
getResponseQueryFromInspector(ResponseQueryInspector responseQueryInspector)
Gets a response query from an inspector.
|
ResponseSearchResults |
getResponsesBySearch(ResponseQuery responseQuery,
ResponseSearch responseSearch)
Gets the search results matching the given search query using the
given search.
|
ResponseSearch |
getResponseSearch()
Gets a response search.
|
ResponseSearchOrder |
getResponseSearchOrder()
Gets a response search order.
|
canSearchResponses, getInquest, getInquestId, getResponseQuery, getResponsesByQuery, useFederatedInquestView, useIsolatedInquestView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ResponseSearch getResponseSearch()
mandatory
- This method must be implemented. ResponseSearchOrder getResponseSearchOrder()
ResponseSearchOrder
is supplied to a ResponseSearch
to specify the ordering
of results.mandatory
- This method must be implemented. ResponseSearchResults getResponsesBySearch(ResponseQuery responseQuery, ResponseSearch responseSearch) throws OperationFailedException, PermissionDeniedException
responseQuery
- the response queryresponseSearch
- the response searchNullArgumentException
- responseQuery
or
responseSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- responseQuery
or
responseSearch
is not of this servicemandatory
- This method must be implemented. ResponseQuery getResponseQueryFromInspector(ResponseQueryInspector responseQueryInspector)
ResponseSearchResults.
responseQueryInspector
- a response query inspectorNullArgumentException
- responseQueryInspector
is null
UnsupportedException
- responseQueryInspector
is not of this servicemandatory
- This method must be implemented.