public interface CommitmentQuerySession extends OsidSession
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.
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 |
---|---|
boolean |
canSearchCommitments()
Tests if this user can perform
Commitment searches. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
CommitmentQuery |
getCommitmentQuery()
Gets a commitment query.
|
CommitmentList |
getCommitmentsByQuery(CommitmentQuery commitmentQuery)
Gets a list of
Commitments matching the given
commitment query. |
void |
useFederatedCalendarView()
Federates the view for methods in this session.
|
void |
useIsolatedCalendarView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session. Calendar
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchCommitments()
Commitment
searches. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCalendarView()
mandatory
- This method is must be implemented. void useIsolatedCalendarView()
mandatory
- This method is must be implemented. CommitmentQuery getCommitmentQuery()
mandatory
- This method must be implemented. CommitmentList getCommitmentsByQuery(CommitmentQuery commitmentQuery) throws OperationFailedException, PermissionDeniedException
Commitments
matching the given
commitment query.commitmentQuery
- the commitment query CommitmentList
NullArgumentException
- commitmentQuery is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- commitmentQuery
is not of this servicemandatory
- This method must be implemented.