public interface InquirySearchSession extends InquiryQuerySession
This session provides methods for searching among Inquiry
objects. The search query is constructed using the
InquiryQuery.
getInquiriesByQuery()
is the basic search method and
returns a list of Inquiries.
A more advanced search may be
performed with getInquiriesBySearch().
It accepts an
InquirySearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getInquiriesBySearch()
returns an
InquirySearchResults
that can be used to access the resulting
InquiryList
or be used to perform a search within the
result set through InquirySearch.
This session defines views that offer differing behaviors for searching.
Inquiries may have a record indicated by their respective record
types. The query record is accessed via the InquiryQuery.
Modifier and Type | Method and Description |
---|---|
InquirySearchResults |
getInquiriesBySearch(InquiryQuery inquiryQuery,
InquirySearch inquirySearch)
Gets the search results matching the given search query using the
given search.
|
InquiryQuery |
getInquiryQueryFromInspector(InquiryQueryInspector inquiryQueryInspector)
Gets an inquiry query from an inspector.
|
InquirySearch |
getInquirySearch()
Gets an inquiry search.
|
InquirySearchOrder |
getInquirySearchOrder()
Gets an inquiry search order.
|
canSearchInquiries, getInquest, getInquestId, getInquiriesByQuery, getInquiryQuery, useFederatedInquestView, useIsolatedInquestView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
InquirySearch getInquirySearch()
mandatory
- This method must be implemented. InquirySearchOrder getInquirySearchOrder()
InquirySearchOrder
is
supplied to an InquirySearch
to specify the ordering of
results.mandatory
- This method must be implemented. InquirySearchResults getInquiriesBySearch(InquiryQuery inquiryQuery, InquirySearch inquirySearch) throws OperationFailedException, PermissionDeniedException
inquiryQuery
- the inquiry queryinquirySearch
- the inquiry searchNullArgumentException
- inquiryQuery
or
inquirySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inquiryQuery
or
inquirySearch
is not of this servicemandatory
- This method must be implemented. InquiryQuery getInquiryQueryFromInspector(InquiryQueryInspector inquiryQueryInspector)
InquirySearchResults.
inquiryQueryInspector
- an inquiry query inspectorNullArgumentException
- inquiryQueryInspector
is null
UnsupportedException
- inquiryQueryInspector
is not of this servicemandatory
- This method must be implemented.