public interface CommitmentSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CommitmentQuery
can be retrieved from this
session and mapped to this Calendar
to create a virtual
collection of Commitments.
The entries may be sequenced
using the CommitmentSearchOrder
from this session.
This Calendar
has a default query that matches any
commitment and a default search order that specifies no sequencing. The
queries may be examined using a CommitmentQueryInspector.
The query may be modified by converting the inspector back to a
CommitmentQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCommitmentQuery(CommitmentQuery commitmentQuery)
Applies a commitment query to this calendar.
|
void |
applyCommitmentSequencing(CommitmentSearchOrder commitmentSearchOrder)
Applies a commitment 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. |
CommitmentQuery |
getCommitmentQuery()
Gets a commitment query.
|
CommitmentQuery |
getCommitmentQueryFromInspector(CommitmentQueryInspector commitmentQueryInspector)
Gets a commitment query from an inspector.
|
CommitmentSearchOrder |
getCommitmentSearchOrder()
Gets a commitment search order.
|
CommitmentQueryInspector |
inspectCommitmentQuery()
Gets a commitment 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. Calendar
associated with this sessionOperationFailedException
- 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 smart operations. false
if smart calendar methods are not
authorized, true
otherwisemandatory
- This method must be implemented. CommitmentQuery getCommitmentQuery()
mandatory
- This method must be implemented. CommitmentSearchOrder getCommitmentSearchOrder()
mandatory
- This method must be implemented. void applyCommitmentQuery(CommitmentQuery commitmentQuery) throws OperationFailedException, PermissionDeniedException
commitmentQuery
- the commitment queryNullArgumentException
- commitmentQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- commitmentQuery
not of this servicemandatory
- This method must be implemented. CommitmentQueryInspector inspectCommitmentQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCommitmentSequencing(CommitmentSearchOrder commitmentSearchOrder) throws OperationFailedException, PermissionDeniedException
commitmentSearchOrder
- the commitment search orderNullArgumentException
- commitmentSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- commitmentSearchOrder
not of this servicemandatory
- This method must be implemented. CommitmentQuery getCommitmentQueryFromInspector(CommitmentQueryInspector commitmentQueryInspector)
commitmentQueryInspector
- a commitment query inspectorNullArgumentException
- commitmentQueryInspector
is null
UnsupportedException
- commitmentQueryInspector
is not of this servicemandatory
- This method must be implemented.