public interface ScheduleSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ScheduleQuery
can be retrieved from this
session and mapped to this Calendar
to create a virtual
collection of Schedules.
The entries may be sequenced using
the ScheduleSearchOrder
from this session.
This Calendar
has a default query that matches any
schedule and a default search order that specifies no sequencing. The
queries may be examined using a ScheduleQueryInspector.
The
query may be modified by converting the inspector back to a
ScheduleQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyScheduleQuery(ScheduleQuery scheduleQuery)
Applies a schedule query to this calendar.
|
void |
applyScheduleSequencing(ScheduleSearchOrder scheduleSearchOrder)
Applies a schedule 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. |
ScheduleQuery |
getScheduleQuery()
Gets a schedule query.
|
ScheduleQuery |
getScheduleQueryFromInspector(ScheduleQueryInspector scheduleQueryInspector)
Gets a schedule query from an inspector.
|
ScheduleSearchOrder |
getScheduleSearchOrder()
Gets a schedule search order.
|
ScheduleQueryInspector |
inspectScheduleQuery()
Gets a schedule 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. ScheduleQuery getScheduleQuery()
mandatory
- This method must be implemented. ScheduleSearchOrder getScheduleSearchOrder()
mandatory
- This method must be implemented. void applyScheduleQuery(ScheduleQuery scheduleQuery) throws OperationFailedException, PermissionDeniedException
scheduleQuery
- the schedule queryNullArgumentException
- scheduleQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- scheduleQuery
not
of this servicemandatory
- This method must be implemented. ScheduleQueryInspector inspectScheduleQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyScheduleSequencing(ScheduleSearchOrder scheduleSearchOrder) throws OperationFailedException, PermissionDeniedException
scheduleSearchOrder
- the schedule search orderNullArgumentException
- scheduleSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- scheduleSearchOrder
not of this servicemandatory
- This method must be implemented. ScheduleQuery getScheduleQueryFromInspector(ScheduleQueryInspector scheduleQueryInspector)
scheduleQueryInspector
- a schedule query inspectorNullArgumentException
- scheduleQueryInspector
is null
UnsupportedException
- scheduleQueryInspector
is not of this servicemandatory
- This method must be implemented.