public interface SupersedingEventEnablerSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
calendars. A SupersedingEventEnablerQuery
can be retrieved
from this session and mapped to this Calendar
to create a
virtual collection of superseding event enablers. The superseding event
enablers may be sequenced using the
SupersedingEventEnablerSearchOrder
from this session.
This Calendar
has a default query that matches any
superseding event enabler and a default search order that specifies no
sequencing. The queries may be examined using a
SupersedingEventEnablerQueryInspector.
The query may be modified
by converting the inspector back to a SupersedingEventEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applySupersedingEventEnablerQuery(SupersedingEventEnablerQuery calendarEnablerQuery)
Applies a superseding event enabler query to this calendar.
|
void |
applySupersedingEventEnablerSequencing(SupersedingEventEnablerSearchOrder calendarEnablerSearchOrder)
Applies a superseding 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. |
SupersedingEventEnablerQuery |
getSupersedingEventEnablerQuery()
Gets a superseding event enabler query.
|
SupersedingEventEnablerQuery |
getSupersedingEventEnablerQueryFromInspector(SupersedingEventEnablerQueryInspector calendarEnablerQueryInspector)
Gets a superseding event enabler query from an inspector.
|
SupersedingEventEnablerSearchOrder |
getSupersedingEventEnablerSearchOrder()
Gets a superseding event enabler search order.
|
SupersedingEventEnablerQueryInspector |
inspectSupersedingEventEnablerQuery()
Gets a superseding 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. SupersedingEventEnablerQuery getSupersedingEventEnablerQuery()
mandatory
- This method must be implemented. SupersedingEventEnablerSearchOrder getSupersedingEventEnablerSearchOrder()
mandatory
- This method must be implemented. void applySupersedingEventEnablerQuery(SupersedingEventEnablerQuery calendarEnablerQuery) throws OperationFailedException, PermissionDeniedException
calendarEnablerQuery
- the superseding event enabler queryNullArgumentException
- calendarEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- calendarEnablerQuery
not of this servicemandatory
- This method must be implemented. SupersedingEventEnablerQueryInspector inspectSupersedingEventEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applySupersedingEventEnablerSequencing(SupersedingEventEnablerSearchOrder calendarEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
calendarEnablerSearchOrder
- the superseding event enabler
search orderNullArgumentException
-
calendarEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
calendarEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. SupersedingEventEnablerQuery getSupersedingEventEnablerQueryFromInspector(SupersedingEventEnablerQueryInspector calendarEnablerQueryInspector)
calendarEnablerQueryInspector
- a superseding event enabler
query inspectorNullArgumentException
-
calendarEnablerQueryInspector
is null
UnsupportedException
-
calendarEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.