public interface RecurringEventSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A RecurringEventQuery
can be retrieved from this
session and mapped to this Calendar
to create a virtual
collection of RecurringEvents.
The entries may be sequenced
using the RecurringEventSearchOrder
from this session.
This Calendar
has a default query that matches any
recurring event and a default search order that specifies no sequencing.
The queries may be examined using a RecurringEventQueryInspector.
The query may be modified by converting the inspector back to a
RecurringEventQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRecurringEventQuery(RecurringEventQuery recurringEventQuery)
Applies a recurring event query to this calendar.
|
void |
applyRecurringEventSequencing(RecurringEventSearchOrder recurringEventSearchOrder)
Applies a recurring event 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. |
RecurringEventQuery |
getRecurringEventQuery()
Gets a recurring event query.
|
RecurringEventQuery |
getRecurringEventQueryFromInspector(RecurringEventQueryInspector recurringEventQueryInspector)
Gets a recurring event query from an inspector.
|
RecurringEventSearchOrder |
getRecurringEventSearchOrder()
Gets a recurring event search order.
|
RecurringEventQueryInspector |
inspectRecurringEventQuery()
Gets a recurring event 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. RecurringEventQuery getRecurringEventQuery()
mandatory
- This method must be implemented. RecurringEventSearchOrder getRecurringEventSearchOrder()
mandatory
- This method must be implemented. void applyRecurringEventQuery(RecurringEventQuery recurringEventQuery) throws OperationFailedException, PermissionDeniedException
recurringEventQuery
- the recurring event queryNullArgumentException
- recurringEventQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- recurringEventQuery
not of this servicemandatory
- This method must be implemented. RecurringEventQueryInspector inspectRecurringEventQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRecurringEventSequencing(RecurringEventSearchOrder recurringEventSearchOrder) throws OperationFailedException, PermissionDeniedException
recurringEventSearchOrder
- the recurring event search orderNullArgumentException
-
recurringEventSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- recurringEventSearchOrder
not of this servicemandatory
- This method must be implemented. RecurringEventQuery getRecurringEventQueryFromInspector(RecurringEventQueryInspector recurringEventQueryInspector)
recurringEventQueryInspector
- a recurring event query inspectorNullArgumentException
-
recruringEventQueryInspector
is null
UnsupportedException
-
recurringEventQueryInspector
is not of this servicemandatory
- This method must be implemented.