public interface InquiryEnablerSearchSession extends InquiryEnablerQuerySession
This session provides methods for searching among InquiryEnabler
objects. The search query is constructed using the
InquiryEnableryQuery.
getInquiryEnablersByQuery()
is the basic search method
and returns a list of InquiryEnablers.
A more advanced
search may be performed with getInquiryEnablersBySearch().
It accepts an InquiryEnablerSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as inquiry. getInquiryEnablersBySearch()
returns an InquiryEnablerSearchResults
that can be used to
access the resulting InquiryEnablerList
or be used to
perform a search within the result set through
InquiryEnablerSearch.
This session defines views that offer differing behaviors for searching.
InquiryEnablers
may have a query record indicated by
their respective record types. The query record is accessed via the
InquiryEnablerQuery.
Modifier and Type | Method and Description |
---|---|
InquiryEnablerQuery |
getInquiryEnablerQueryFromInspector(InquiryEnablerQueryInspector inquiryEnablerQueryInspector)
Gets an inquiry enabler query from an inspector.
|
InquiryEnablerSearchResults |
getInquiryEnablersBySearch(InquiryEnablerQuery inquiryEnablerQuery,
InquiryEnablerSearch inquiryEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
InquiryEnablerSearch |
getInquiryEnablerSearch()
Gets an inquiry enabler search.
|
InquiryEnablerSearchOrder |
getInquiryEnablerSearchOrder()
Gets an inquiry enabler search order.
|
canSearchInquiryEnablers, getInquest, getInquestId, getInquiryEnablerQuery, getInquiryEnablersByQuery, useFederatedInquestView, useIsolatedInquestView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
InquiryEnablerSearch getInquiryEnablerSearch()
mandatory
- This method must be implemented. InquiryEnablerSearchOrder getInquiryEnablerSearchOrder()
InquiryEnablerSearchOrder
is supplied to an
InquiryEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. InquiryEnablerSearchResults getInquiryEnablersBySearch(InquiryEnablerQuery inquiryEnablerQuery, InquiryEnablerSearch inquiryEnablerSearch) throws OperationFailedException, PermissionDeniedException
inquiryEnablerQuery
- the inquiry enabler queryinquiryEnablerSearch
- the inquiry enabler searchNullArgumentException
- inquiryEnablerQuery
or inquiryEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inquiryEnablerQuery
or inquiryEnablerSearch
is not of this
servicemandatory
- This method must be implemented. InquiryEnablerQuery getInquiryEnablerQueryFromInspector(InquiryEnablerQueryInspector inquiryEnablerQueryInspector)
InquiryEnablerSearchResults.
inquiryEnablerQueryInspector
- an inquiry enabler query
inspectorNullArgumentException
-
inquiryEnablerQueryInspector
is null
UnsupportedException
-
inquiryEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.