public interface CommitmentSearchSession extends CommitmentQuerySession
This session provides methods for searching Commitment
objects. The search query is constructed using the CommitmentQuery.
The commitment record Type
also specifies the
record for the commitment query.
getCommitmentsByQuery()
is the basic search method and
returns a list of Commitments.
A more advanced search may
be performed with getCommitmentsBySearch().
It accepts a
CommitmentSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getCommitmentsBySearch()
returns an
CommitmentSearchResults
that can be used to access the resulting
CommitmentList
or be used to perform a search within the
result set through CommitmentSearch.
This session defines views that offer differing behaviors for searching.
Commitments may have a query record indicated by their respective
record types. The query record is accessed via the CommitmentQuery.
Modifier and Type | Method and Description |
---|---|
CommitmentQuery |
getCommitmentQueryFromInspector(CommitmentQueryInspector commitmentQueryInspector)
Gets a commitment query from an inspector.
|
CommitmentSearchResults |
getCommitmentsBySearch(CommitmentQuery commitmentQuery,
CommitmentSearch commitmentSearch)
Gets the search results matching the given search query using the
given search.
|
CommitmentSearch |
getCommitmentSearch()
Gets a commitment search.
|
CommitmentSearchOrder |
getCommitmentSearchOrder()
Gets a commitment search order.
|
canSearchCommitments, getCalendar, getCalendarId, getCommitmentQuery, getCommitmentsByQuery, useFederatedCalendarView, useIsolatedCalendarView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CommitmentSearch getCommitmentSearch()
mandatory
- This method must be implemented. CommitmentSearchOrder getCommitmentSearchOrder()
CommitmentSearchOrder
is supplied to a CommitmentSearch
to specify
the ordering of results.mandatory
- This method must be implemented. CommitmentSearchResults getCommitmentsBySearch(CommitmentQuery commitmentQuery, CommitmentSearch commitmentSearch) throws OperationFailedException, PermissionDeniedException
commitmentQuery
- the commitment search querycommitmentSearch
- the commitment searchNullArgumentException
- commitmentQuery
or commitmentSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- commitmentSearch
or commitmentQuery
is not of this servicemandatory
- This method must be implemented. CommitmentQuery getCommitmentQueryFromInspector(CommitmentQueryInspector commitmentQueryInspector)
CommitmentSearchResults.
commitmentQueryInspector
- a commitment query inspectorNullArgumentException
- commitmentQueryInspector
is null
UnsupportedException
- commitmentQueryInspector
is not of this servicemandatory
- This method must be implemented.