public interface OffsetEventEnablerSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
calendars. An OffsetEventEnablerQuery
can be retrieved from
this session and mapped to this Calendar
to create a
virtual collection of offset event enablers. The offset event enablers may
be sequenced using the OffsetEventEnablerSearchOrder
from
this session.
This Calendar
has a default query that matches any
offset event enabler and a default search order that specifies no
sequencing. The queries may be examined using an
OffsetEventEnablerQueryInspector.
The query may be modified by
converting the inspector back to an OffsetEventEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyOffsetEventEnablerQuery(OffsetEventEnablerQuery offsetEventEnablerQuery)
Applies an offset event enabler query to this calendar.
|
void |
applyOffsetEventEnablerSequencing(OffsetEventEnablerSearchOrder offsetEventEnablerSearchOrder)
Applies an offset 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. |
OffsetEventEnablerQuery |
getOffsetEventEnablerQuery()
Gets an offset event enabler query.
|
OffsetEventEnablerQuery |
getOffsetEventEnablerQueryFromInspector(OffsetEventEnablerQueryInspector offsetEventEnablerQueryInspector)
Gets an offset event enabler query from an inspector.
|
OffsetEventEnablerSearchOrder |
getOffsetEventEnablerSearchOrder()
Gets an offset event enabler search order.
|
OffsetEventEnablerQueryInspector |
inspectOffsetEventEnablerQuery()
Gets an offset 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. OffsetEventEnablerQuery getOffsetEventEnablerQuery()
mandatory
- This method must be implemented. OffsetEventEnablerSearchOrder getOffsetEventEnablerSearchOrder()
mandatory
- This method must be implemented. void applyOffsetEventEnablerQuery(OffsetEventEnablerQuery offsetEventEnablerQuery) throws OperationFailedException, PermissionDeniedException
offsetEventEnablerQuery
- the offset event enabler queryNullArgumentException
- offsetEventEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- offsetEventEnablerQuery
not of this servicemandatory
- This method must be implemented. OffsetEventEnablerQueryInspector inspectOffsetEventEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyOffsetEventEnablerSequencing(OffsetEventEnablerSearchOrder offsetEventEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
offsetEventEnablerSearchOrder
- the offset event enabler search
orderNullArgumentException
-
offsetEventEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
offsetEventEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. OffsetEventEnablerQuery getOffsetEventEnablerQueryFromInspector(OffsetEventEnablerQueryInspector offsetEventEnablerQueryInspector)
offsetEventEnablerQueryInspector
- an offset event enabler query
inspectorNullArgumentException
-
offsetEventEnablerQueryInspector
is null
UnsupportedException
-
offsetEventEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.