public interface CommitmentEnablerSearchSession extends CommitmentEnablerQuerySession
This session provides methods for searching among
CommitmentEnabler
objects. The search query is constructed using
the CommitmentEnablerQuery.
getCommitmentEnablersByQuery()
is the basic search
method and returns a list of CommitmentEnablers.
A more
advanced search may be performed with
getCommitmentEnablersBySearch().
It accepts a
CommitmentEnablerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getCommitmentEnablersBySearch()
returns a
CommitmentEnablerSearchResults
that can be used to access the
resulting CommitmentEnablerList
or be used to perform a
search within the result set through CommitmentEnablerSearch.
This session defines views that offer differing behaviors for searching.
CommitmentEnablers
may have a query record indicated by
their respective record types. The query record is accessed via the
CommitmentEnablerQuery.
Modifier and Type | Method and Description |
---|---|
CommitmentEnablerQuery |
getCommitmentEnablerQueryFromInspector(CommitmentEnablerQueryInspector commitmentEnablerQueryInspector)
Gets a commitment enabler query from an inspector.
|
CommitmentEnablerSearchResults |
getCommitmentEnablersBySearch(CommitmentEnablerQuery commitmentEnablerQuery,
CommitmentEnablerSearch commitmentEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
CommitmentEnablerSearch |
getCommitmentEnablerSearch()
Gets a commitment enabler search.
|
CommitmentEnablerSearchOrder |
getCommitmentEnablerSearchOrder()
Gets a commitment enabler search order.
|
canSearchCommitmentEnablers, getCalendar, getCalendarId, getCommitmentEnablerQuery, getCommitmentEnablersByQuery, useFederatedCalendarView, useIsolatedCalendarView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CommitmentEnablerSearch getCommitmentEnablerSearch()
mandatory
- This method must be implemented. CommitmentEnablerSearchOrder getCommitmentEnablerSearchOrder()
CommitmentEnablerSearchOrder
is supplied to a
CommitmentEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. CommitmentEnablerSearchResults getCommitmentEnablersBySearch(CommitmentEnablerQuery commitmentEnablerQuery, CommitmentEnablerSearch commitmentEnablerSearch) throws OperationFailedException, PermissionDeniedException
commitmentEnablerQuery
- the commitment enabler querycommitmentEnablerSearch
- the commitment enabler searchNullArgumentException
- commitmentEnablerQuery
or commitmentEnablerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- commitmentEnablerQuery
or commitmentEnablerSearch
is not of
this servicemandatory
- This method must be implemented. CommitmentEnablerQuery getCommitmentEnablerQueryFromInspector(CommitmentEnablerQueryInspector commitmentEnablerQueryInspector)
CommitmentEnablerSearchResults.
commitmentEnablerQueryInspector
- a commitment enabler query
inspectorNullArgumentException
-
commitmentEnablerQueryInspector
is null
UnsupportedException
-
commitmentEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.