public interface RecurringEventEnablerSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
calendars. A RecurringEventEnablerQuery
can be retrieved
from this session and mapped to this Calendar
to create a
virtual collection of recurring event enablers. The recurring event
enablers may be sequenced using the
RecurringEventEnablerSearchOrder
from this session.
This Calendar
has a default query that matches any
recurring event enabler and a default search order that specifies no
sequencing. The queries may be examined using a
RecurringEventEnablerQueryInspector.
The query may be modified by
converting the inspector back to a RecurringEventEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRecurringEventEnablerQuery(RecurringEventEnablerQuery recurringEventEnablerQuery)
Applies a recurring event enabler query to this calendar.
|
void |
applyRecurringEventEnablerSequencing(RecurringEventEnablerSearchOrder recurringEventEnablerSearchOrder)
Applies a recurring event 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. |
RecurringEventEnablerQuery |
getRecurringEventEnablerQuery()
Gets a recurring event enabler query.
|
RecurringEventEnablerQuery |
getRecurringEventEnablerQueryFromInspector(RecurringEventEnablerQueryInspector recurringEventEnablerQueryInspector)
Gets a recurring event enabler query from an inspector.
|
RecurringEventEnablerSearchOrder |
getRecurringEventEnablerSearchOrder()
Gets a recurring event enabler search order.
|
RecurringEventEnablerQueryInspector |
inspectRecurringEventEnablerQuery()
Gets a recurring event 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. RecurringEventEnablerQuery getRecurringEventEnablerQuery()
mandatory
- This method must be implemented. RecurringEventEnablerSearchOrder getRecurringEventEnablerSearchOrder()
mandatory
- This method must be implemented. void applyRecurringEventEnablerQuery(RecurringEventEnablerQuery recurringEventEnablerQuery) throws OperationFailedException, PermissionDeniedException
recurringEventEnablerQuery
- the recurring event enabler queryNullArgumentException
-
recurringEventEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
recurringEventEnablerQuery
not of this servicemandatory
- This method must be implemented. RecurringEventEnablerQueryInspector inspectRecurringEventEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRecurringEventEnablerSequencing(RecurringEventEnablerSearchOrder recurringEventEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
recurringEventEnablerSearchOrder
- the recurring event enabler
search orderNullArgumentException
-
recurringEventEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
recurringEventEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. RecurringEventEnablerQuery getRecurringEventEnablerQueryFromInspector(RecurringEventEnablerQueryInspector recurringEventEnablerQueryInspector)
recurringEventEnablerQueryInspector
- a recurring event enabler
query inspectorNullArgumentException
-
recurringEventEnablerQueryInspector
is null
UnsupportedException
-
recurringEventEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.