org.osid.calendaring.rules

Interface OffsetEventEnablerSmartCalendarSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface OffsetEventEnablerSmartCalendarSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic calendars. An OffsetEventEnablerQuery can be retrieved from this session and mapped to this Calendar to create a virtual collection of offset event enablers. The offset event enablers may be sequenced using the OffsetEventEnablerSearchOrder from this session.

This Calendar has a default query that matches any offset event enabler and a default search order that specifies no sequencing. The queries may be examined using an OffsetEventEnablerQueryInspector. The query may be modified by converting the inspector back to an OffsetEventEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyOffsetEventEnablerQuery(OffsetEventEnablerQuery offsetEventEnablerQuery) Applies an offset event enabler query to this calendar.
void	applyOffsetEventEnablerSequencing(OffsetEventEnablerSearchOrder offsetEventEnablerSearchOrder) Applies an offset event enabler 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.
OffsetEventEnablerQuery	getOffsetEventEnablerQuery() Gets an offset event enabler query.
OffsetEventEnablerQuery	getOffsetEventEnablerQueryFromInspector(OffsetEventEnablerQueryInspector offsetEventEnablerQueryInspector) Gets an offset event enabler query from an inspector.
OffsetEventEnablerSearchOrder	getOffsetEventEnablerSearchOrder() Gets an offset event enabler search order.
OffsetEventEnablerQueryInspector	inspectOffsetEventEnablerQuery() Gets an offset event enabler query inspector for this calendar.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCalendarId

Id getCalendarId()

Gets the Calendar Id associated with this session.

Returns:

the Calendar Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCalendar

Calendar getCalendar()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Calendar associated with this session.

Returns:

the calendar

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartCalendars

boolean canManageSmartCalendars()

Tests if this user can manage smart calendars. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart calendar management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablerQuery

OffsetEventEnablerQuery getOffsetEventEnablerQuery()

Gets an offset event enabler query.

Returns:

the offset event enabler query

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablerSearchOrder

OffsetEventEnablerSearchOrder getOffsetEventEnablerSearchOrder()

Gets an offset event enabler search order.

Returns:

the offset event enabler search order

Compliance:

mandatory - This method must be implemented.

applyOffsetEventEnablerQuery

void applyOffsetEventEnablerQuery(OffsetEventEnablerQuery offsetEventEnablerQuery)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Applies an offset event enabler query to this calendar.

Parameters:

offsetEventEnablerQuery - the offset event enabler query

Throws:

NullArgumentException - offsetEventEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - offsetEventEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectOffsetEventEnablerQuery

OffsetEventEnablerQueryInspector inspectOffsetEventEnablerQuery()
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

Gets an offset event enabler query inspector for this calendar.

Returns:

the offset event enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyOffsetEventEnablerSequencing

void applyOffsetEventEnablerSequencing(OffsetEventEnablerSearchOrder offsetEventEnablerSearchOrder)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Applies an offset event enabler search order to this calendar.

Parameters:

offsetEventEnablerSearchOrder - the offset event enabler search order

Throws:

NullArgumentException - offsetEventEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - offsetEventEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablerQueryFromInspector

OffsetEventEnablerQuery getOffsetEventEnablerQueryFromInspector(OffsetEventEnablerQueryInspector offsetEventEnablerQueryInspector)

Gets an offset event enabler query from an inspector.

Parameters:

offsetEventEnablerQueryInspector - an offset event enabler query inspector

Returns:

the offset event enabler query

Throws:

NullArgumentException - offsetEventEnablerQueryInspector is null

UnsupportedException - offsetEventEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.