public interface CyclicTimePeriodSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CyclicTimePeriodQuery
can be retrieved from
this session and mapped to this Calendar
to create a
virtual collection of TomePeriods.
The entries may be
sequenced using the CyclicTimePeriodSearchOrder
from this
session.
This Calendar
has a default query that matches any
cyclic time period and a default search order that specifies no
sequencing. The queries may be examined using a
CyclicTimePeriodQueryInspector.
The query may be modified by
converting the inspector back to a CyclicTimePeriodQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCyclicTimePeriodQuery(CyclicTimePeriodQuery cyclicTimePeriodQuery)
Applies a cyclic time period query to this calendar.
|
void |
applyCyclicTimePeriodSequencing(CyclicTimePeriodSearchOrder cyclicTimePeriodSearchOrder)
Applies a cyclic time period 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. |
CyclicTimePeriodQuery |
getCyclicTimePeriodQuery()
Gets a cyclic time period query.
|
CyclicTimePeriodQuery |
getCyclicTimePeriodQueryFromInspector(CyclicTimePeriodQueryInspector cyclicTimePeriodQueryInspector)
Gets a cyclic time period query from an inspector.
|
CyclicTimePeriodSearchOrder |
getCyclicTimePeriodSearchOrder()
Gets a cyclic time period search order.
|
CyclicTimePeriodQueryInspector |
inspectCyclicTimePeriodQuery()
Gets a cyclic time period 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. CyclicTimePeriodQuery getCyclicTimePeriodQuery()
mandatory
- This method must be implemented. CyclicTimePeriodSearchOrder getCyclicTimePeriodSearchOrder()
mandatory
- This method must be implemented. void applyCyclicTimePeriodQuery(CyclicTimePeriodQuery cyclicTimePeriodQuery) throws OperationFailedException, PermissionDeniedException
cyclicTimePeriodQuery
- the cyclic time period queryNullArgumentException
- cyclicTimePeriodQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- cyclicTimePeriodQuery
not of this servicemandatory
- This method must be implemented. CyclicTimePeriodQueryInspector inspectCyclicTimePeriodQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCyclicTimePeriodSequencing(CyclicTimePeriodSearchOrder cyclicTimePeriodSearchOrder) throws OperationFailedException, PermissionDeniedException
cyclicTimePeriodSearchOrder
- the cyclic time period search
orderNullArgumentException
-
cyclicTimePeriodSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
cyclicTimePeriodSearchOrder
not of this servicemandatory
- This method must be implemented. CyclicTimePeriodQuery getCyclicTimePeriodQueryFromInspector(CyclicTimePeriodQueryInspector cyclicTimePeriodQueryInspector)
cyclicTimePeriodQueryInspector
- a cyclic time period query
inspectorNullArgumentException
-
cyclicTimePeriodQueryInspector
is null
UnsupportedException
-
cyclicTimePeriodQueryInspector
is not of this servicemandatory
- This method must be implemented.