public interface CyclicEventSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CyclicEventQuery
can be retrieved from this
session and mapped to this Calendar
to create a virtual
collection of CyclicEvents.
The entries may be sequenced
using the CyclicEventSearchOrder
from this session.
This Calendar
has a default query that matches any
event and a default search order that specifies no sequencing. The queries
may be examined using a CyclicEventQueryInspector.
The
query may be modified by converting the inspector back to a
CyclicEventQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyEventQuery(CyclicEventQuery cyclicEventQuery)
Applies a cyclic event query to this calendar.
|
void |
applyEventSequencing(CyclicEventSearchOrder cyclicEventSearchOrder)
Applies a cyclic 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. |
CyclicEventQuery |
getCyclicEventQuery()
Gets a cyclic event query.
|
CyclicEventQuery |
getCyclicEventQueryFromInspector(CyclicEventQueryInspector cyclicEventQueryInspector)
Gets a cyclic event query from an inspector.
|
CyclicEventSearchOrder |
getCyclicEventSearchOrder()
Gets a cyclic event search order.
|
CyclicEventQueryInspector |
inspectEventQuery()
Gets a cyclic 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. CyclicEventQuery getCyclicEventQuery()
mandatory
- This method must be implemented. CyclicEventSearchOrder getCyclicEventSearchOrder()
mandatory
- This method must be implemented. void applyEventQuery(CyclicEventQuery cyclicEventQuery) throws OperationFailedException, PermissionDeniedException
cyclicEventQuery
- the cyclic event queryNullArgumentException
- cyclicEventQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- cyclicEventQuery
not of this servicemandatory
- This method must be implemented. CyclicEventQueryInspector inspectEventQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyEventSequencing(CyclicEventSearchOrder cyclicEventSearchOrder) throws OperationFailedException, PermissionDeniedException
cyclicEventSearchOrder
- the cyclic event search orderNullArgumentException
- cyclicEventSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- cyclicEventSearchOrder
not of this servicemandatory
- This method must be implemented. CyclicEventQuery getCyclicEventQueryFromInspector(CyclicEventQueryInspector cyclicEventQueryInspector)
cyclicEventQueryInspector
- a cyclic event query inspectorNullArgumentException
-
cyclicEventQueryInspector
is null
UnsupportedException
- cyclicEventQueryInspector
is not of this servicemandatory
- This method must be implemented.