public interface OffsetEventSmartCalendarSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An OffsetEventQuery
can be retrieved from this
session and mapped to this Calendar
to create a virtual
collection of OffsetEvents.
The entries may be sequenced
using the OffsetEventSearchOrder
from this session.
This Calendar
has a default query that matches any
offset event and a default search order that specifies no sequencing. The
queries may be examined using an OffsetEventQueryInspector.
The query may be modified by converting the inspector back to an
OffsetEventQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyOffsetEventQuery(OffsetEventQuery offsetEventQuery)
Applies an offset event query to this calendar.
|
void |
applyOffsetEventSequencing(OffsetEventSearchOrder offsetEventSearchOrder)
Applies an offset 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. |
OffsetEventQuery |
getOffsetEventQuery()
Gets an offset event query.
|
OffsetEventQuery |
getOffsetEventQueryFromInspector(OffsetEventQueryInspector offsetEventQueryInspector)
Gets an offset event query from an inspector.
|
OffsetEventSearchOrder |
getOffsetEventSearchOrder()
Gets an offset event search order.
|
OffsetEventQueryInspector |
inspectOffsetEventQuery()
Gets an offset 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. OffsetEventQuery getOffsetEventQuery()
mandatory
- This method must be implemented. OffsetEventSearchOrder getOffsetEventSearchOrder()
mandatory
- This method must be implemented. void applyOffsetEventQuery(OffsetEventQuery offsetEventQuery) throws OperationFailedException, PermissionDeniedException
offsetEventQuery
- the offset event queryNullArgumentException
- offsetEventQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- offsetEventQuery
not of this servicemandatory
- This method must be implemented. OffsetEventQueryInspector inspectOffsetEventQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyOffsetEventSequencing(OffsetEventSearchOrder offsetEventSearchOrder) throws OperationFailedException, PermissionDeniedException
offsetEventSearchOrder
- the offset event search orderNullArgumentException
- offsetEventSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- offsetEventSearchOrder
not of this servicemandatory
- This method must be implemented. OffsetEventQuery getOffsetEventQueryFromInspector(OffsetEventQueryInspector offsetEventQueryInspector)
offsetEventQueryInspector
- an offset event query inspectorNullArgumentException
-
offsetEventQueryInspector
is null
UnsupportedException
- offsetEventQueryInspector
is not of this servicemandatory
- This method must be implemented.