public interface InquestSearchSession extends InquestQuerySession
This session provides methods for searching among Inquest
objects. The search query is constructed using the
InquestQuery.
getInquestsByQuery()
is the basic search method and
returns a list of Inquests.
A more advanced search may be
performed with getInquestsBySearch().
It accepts an
InquestSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getInquestsBySearch()
returns an
InquestSearchResults
that can be used to access the resulting
InquestList
or be used to perform a search within the
result set through InquestSearch.
Inquests may have a query record indicated by their respective record
types. The query record is accessed via the InquestQuery.
Modifier and Type | Method and Description |
---|---|
InquestQuery |
getInquestQueryFromInspector(InquestQueryInspector inquestQueryInspector)
Gets an inquest query from an inspector.
|
InquestSearchResults |
getInquestsBySearch(InquestQuery inquestQuery,
InquestSearch inquestSearch)
Gets the search results matching the given search query using the
given search.
|
InquestSearch |
getInquestSearch()
Gets an inquest search.
|
InquestSearchOrder |
getInquestSearchOrder()
Gets an inquest search order.
|
canSearchInquests, getInquestQuery, getInquestsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
InquestSearch getInquestSearch()
mandatory
- This method must be implemented. InquestSearchOrder getInquestSearchOrder()
InquestSearchOrder
is
supplied to an InquestSearch
to specify the ordering of
results.mandatory
- This method must be implemented. InquestSearchResults getInquestsBySearch(InquestQuery inquestQuery, InquestSearch inquestSearch) throws OperationFailedException, PermissionDeniedException
inquestQuery
- the inquest queryinquestSearch
- the inquest searchNullArgumentException
- inquestQuery
or
inquestSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inquestQuery
or
inquestSearch
is not of this servicemandatory
- This method must be implemented. InquestQuery getInquestQueryFromInspector(InquestQueryInspector inquestQueryInspector)
InquestSearchResults.
inquestQueryInspector
- an inquest query inspectorNullArgumentException
- inquestQueryInspector
is null
UnsupportedException
- inquestQueryInspector
is not of this servicemandatory
- This method must be implemented.