public interface CommitmentEnablerQuerySession extends OsidSession
This session provides methods for searching among
CommitmentEnabler
objects. The search query is constructed using
the CommitmentEnablerQuery.
This session defines views that offer differing behaviors for searching.
Commitment enablers 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 |
---|---|
boolean |
canSearchCommitmentEnablers()
Tests if this user can perform
CommitmentEnabler
lookups. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
CommitmentEnablerQuery |
getCommitmentEnablerQuery()
Gets a commitment enabler query.
|
CommitmentEnablerList |
getCommitmentEnablersByQuery(CommitmentEnablerQuery commitmentEnablerQuery)
Gets a list of
CommitmentEnablers matching the given
commitment enabler 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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchCommitmentEnablers()
CommitmentEnabler
lookups. 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 not offer lookup
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. CommitmentEnablerQuery getCommitmentEnablerQuery()
mandatory
- This method must be implemented. CommitmentEnablerList getCommitmentEnablersByQuery(CommitmentEnablerQuery commitmentEnablerQuery) throws OperationFailedException, PermissionDeniedException
CommitmentEnablers
matching the given
commitment enabler query.commitmentEnablerQuery
- the commitment enabler query CommitmentEnablerList
NullArgumentException
- commitmentEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- commitmentEnablerQuery
is not of this servicemandatory
- This method must be implemented.