public interface ScheduleSlotSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ScheduleSlotQuery
can be retrieved from this
session and mapped to this Calendar
to create a virtual
collection of ScheduleSlots.
The entries may be sequenced
using the ScheduleSlotSearchOrder
from this session.
This Calendar
has a default query that matches any
schedule slot and a default search order that specifies no sequencing. The
queries may be examined using a ScheduleSlotQueryInspector.
The query may be modified by converting the inspector back to a
ScheduleSlotQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyScheduleSlotQuery(ScheduleSlotQuery scheduleSlotQuery)
Applies a schedule slot query to this calendar.
|
void |
applyScheduleSlotSequencing(ScheduleSlotSearchOrder scheduleSlotSearchOrder)
Applies a schedule slot 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. |
ScheduleSlotQuery |
getScheduleSlotQuery()
Gets a schedule slot query.
|
ScheduleSlotQuery |
getScheduleSlotQueryFromInspector(ScheduleSlotQueryInspector scheduleSlotQueryInspector)
Gets a schedule slot query from an inspector.
|
ScheduleSlotSearchOrder |
getScheduleSlotSearchOrder()
Gets a schedule slot search order.
|
ScheduleSlotQueryInspector |
inspectScheduleSlotQuery()
Gets a schedule slot 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. ScheduleSlotQuery getScheduleSlotQuery()
mandatory
- This method must be implemented. ScheduleSlotSearchOrder getScheduleSlotSearchOrder()
mandatory
- This method must be implemented. void applyScheduleSlotQuery(ScheduleSlotQuery scheduleSlotQuery) throws OperationFailedException, PermissionDeniedException
scheduleSlotQuery
- the schedule slot queryNullArgumentException
- scheduleSlotQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- scheduleSlotQuery
not of this servicemandatory
- This method must be implemented. ScheduleSlotQueryInspector inspectScheduleSlotQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyScheduleSlotSequencing(ScheduleSlotSearchOrder scheduleSlotSearchOrder) throws OperationFailedException, PermissionDeniedException
scheduleSlotSearchOrder
- the schedule slot search orderNullArgumentException
- scheduleSlotSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- scheduleSlotSearchOrder
not of this servicemandatory
- This method must be implemented. ScheduleSlotQuery getScheduleSlotQueryFromInspector(ScheduleSlotQueryInspector scheduleSlotQueryInspector)
scheduleSlotQueryInspector
- a schedule slot query inspectorNullArgumentException
-
scheduleSlotQueryInspector
is null
UnsupportedException
-
scheduleSlotQueryInspector
is not of this servicemandatory
- This method must be implemented.