public interface CommitmentEnablerSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
calendars. A CommitmentEnablerQuery
can be retrieved from
this session and mapped to this Calendar
to create a
virtual collection of commitment enablers. The commitment enablers may be
sequenced using the CommitmentEnablerSearchOrder
from this
session.
This Calendar
has a default query that matches any
commitment enabler and a default search order that specifies no
sequencing. The queries may be examined using a
CommitmentEnablerQueryInspector.
The query may be modified by
converting the inspector back to a CommitmentEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCommitmentEnablerQuery(CommitmentEnablerQuery commitmentEnablerQuery)
Applies a commitment enabler query to this calendar.
|
void |
applyCommitmentEnablerSequencing(CommitmentEnablerSearchOrder commitmentEnablerSearchOrder)
Applies a commitment enabler search order to this calendar.
|
boolean |
canManageSmartCalendars()
Tests if this user can manage smart calendars.
|
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.
|
CommitmentEnablerQuery |
getCommitmentEnablerQueryFromInspector(CommitmentEnablerQueryInspector commitmentEnablerQueryInspector)
Gets a commitment enabler query from an inspector.
|
CommitmentEnablerSearchOrder |
getCommitmentEnablerSearchOrder()
Gets a commitment enabler search order.
|
CommitmentEnablerQueryInspector |
inspectCommitmentEnablerQuery()
Gets a commitment enabler query inspector for this calendar.
|
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 canManageSmartCalendars()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart calendar management is not
authorized, true
otherwisemandatory
- This method must be implemented. CommitmentEnablerQuery getCommitmentEnablerQuery()
mandatory
- This method must be implemented. CommitmentEnablerSearchOrder getCommitmentEnablerSearchOrder()
mandatory
- This method must be implemented. void applyCommitmentEnablerQuery(CommitmentEnablerQuery commitmentEnablerQuery) throws OperationFailedException, PermissionDeniedException
commitmentEnablerQuery
- the commitment enabler queryNullArgumentException
- commitmentEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- commitmentEnablerQuery
not of this servicemandatory
- This method must be implemented. CommitmentEnablerQueryInspector inspectCommitmentEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCommitmentEnablerSequencing(CommitmentEnablerSearchOrder commitmentEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
commitmentEnablerSearchOrder
- the commitment enabler search
orderNullArgumentException
-
commitmentEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
commitmentEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. CommitmentEnablerQuery getCommitmentEnablerQueryFromInspector(CommitmentEnablerQueryInspector commitmentEnablerQueryInspector)
commitmentEnablerQueryInspector
- a commitment enabler query
inspectorNullArgumentException
-
commitmentEnablerQueryInspector
is null
UnsupportedException
-
commitmentEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.