public interface TimePeriodSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A TimePeriodQuery
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 TimePeriodSearchOrder
from this session.
This Calendar
has a default query that matches any time
period and a default search order that specifies no sequencing. The
queries may be examined using a TimePeriodQueryInspector.
The query may be modified by converting the inspector back to a
TimePeriodQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyTimePeriodQuery(TimePeriodQuery timePeriodQuery)
Applies a time period query to this calendar.
|
void |
applyTimePeriodSequencing(TimePeriodSearchOrder timePeriodSearchOrder)
Applies a 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. |
TimePeriodQuery |
getTimePeriodQuery()
Gets a time period query.
|
TimePeriodQuery |
getTimePeriodQueryFromInspector(TimePeriodQueryInspector timePeriodQueryInspector)
Gets a time period query from an inspector.
|
TimePeriodSearchOrder |
getTimePeriodSearchOrder()
Gets a time period search order.
|
TimePeriodQueryInspector |
inspectTimePeriodQuery()
Gets a 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. TimePeriodQuery getTimePeriodQuery()
mandatory
- This method must be implemented. TimePeriodSearchOrder getTimePeriodSearchOrder()
mandatory
- This method must be implemented. void applyTimePeriodQuery(TimePeriodQuery timePeriodQuery) throws OperationFailedException, PermissionDeniedException
timePeriodQuery
- the time period queryNullArgumentException
- timePeriodQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- timePeriodQuery
not of this servicemandatory
- This method must be implemented. TimePeriodQueryInspector inspectTimePeriodQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyTimePeriodSequencing(TimePeriodSearchOrder timePeriodSearchOrder) throws OperationFailedException, PermissionDeniedException
timePeriodSearchOrder
- the time period search orderNullArgumentException
- timePeriodSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- timePeriodSearchOrder
not of this servicemandatory
- This method must be implemented. TimePeriodQuery getTimePeriodQueryFromInspector(TimePeriodQueryInspector timePeriodQueryInspector)
timePeriodQueryInspector
- a time period query inspectorNullArgumentException
- timePeriodQueryInspector
is null
UnsupportedException
- timePeriodQueryInspector
is not of this servicemandatory
- This method must be implemented.