org.osid.calendaring.rules

Interface RecurringEventEnablerSmartCalendarSession

All Superinterfaces:

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

public interface RecurringEventEnablerSmartCalendarSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic calendars. A RecurringEventEnablerQuery can be retrieved from this session and mapped to this Calendar to create a virtual collection of recurring event enablers. The recurring event enablers may be sequenced using the RecurringEventEnablerSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyRecurringEventEnablerQuery(RecurringEventEnablerQuery recurringEventEnablerQuery) Applies a recurring event enabler query to this calendar.
void	applyRecurringEventEnablerSequencing(RecurringEventEnablerSearchOrder recurringEventEnablerSearchOrder) Applies a recurring 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.
RecurringEventEnablerQuery	getRecurringEventEnablerQuery() Gets a recurring event enabler query.
RecurringEventEnablerQuery	getRecurringEventEnablerQueryFromInspector(RecurringEventEnablerQueryInspector recurringEventEnablerQueryInspector) Gets a recurring event enabler query from an inspector.
RecurringEventEnablerSearchOrder	getRecurringEventEnablerSearchOrder() Gets a recurring event enabler search order.
RecurringEventEnablerQueryInspector	inspectRecurringEventEnablerQuery() Gets a recurring 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.

getRecurringEventEnablerQuery

RecurringEventEnablerQuery getRecurringEventEnablerQuery()

Gets a recurring event enabler query.

Returns:

the recurring event enabler query

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerSearchOrder

RecurringEventEnablerSearchOrder getRecurringEventEnablerSearchOrder()

Gets a recurring event enabler search order.

Returns:

the recurring event enabler search order

Compliance:

mandatory - This method must be implemented.

applyRecurringEventEnablerQuery

void applyRecurringEventEnablerQuery(RecurringEventEnablerQuery recurringEventEnablerQuery)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Applies a recurring event enabler query to this calendar.

Parameters:

recurringEventEnablerQuery - the recurring event enabler query

Throws:

NullArgumentException - recurringEventEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - recurringEventEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectRecurringEventEnablerQuery

RecurringEventEnablerQueryInspector inspectRecurringEventEnablerQuery()
                                                                      throws OperationFailedException,
                                                                             PermissionDeniedException

Gets a recurring event enabler query inspector for this calendar.

Returns:

the recurring event enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyRecurringEventEnablerSequencing

void applyRecurringEventEnablerSequencing(RecurringEventEnablerSearchOrder recurringEventEnablerSearchOrder)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Applies a recurring event enabler search order to this calendar.

Parameters:

recurringEventEnablerSearchOrder - the recurring event enabler search order

Throws:

NullArgumentException - recurringEventEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - recurringEventEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerQueryFromInspector

RecurringEventEnablerQuery getRecurringEventEnablerQueryFromInspector(RecurringEventEnablerQueryInspector recurringEventEnablerQueryInspector)

Gets a recurring event enabler query from an inspector.

Parameters:

recurringEventEnablerQueryInspector - a recurring event enabler query inspector

Returns:

the recurring event enabler query

Throws:

NullArgumentException - recurringEventEnablerQueryInspector is null

UnsupportedException - recurringEventEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.