org.osid.calendaring.rules

Interface SupersedingEventEnablerSmartCalendarSession

All Superinterfaces:

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

public interface SupersedingEventEnablerSmartCalendarSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applySupersedingEventEnablerQuery(SupersedingEventEnablerQuery calendarEnablerQuery) Applies a superseding event enabler query to this calendar.
void	applySupersedingEventEnablerSequencing(SupersedingEventEnablerSearchOrder calendarEnablerSearchOrder) Applies a superseding 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.
SupersedingEventEnablerQuery	getSupersedingEventEnablerQuery() Gets a superseding event enabler query.
SupersedingEventEnablerQuery	getSupersedingEventEnablerQueryFromInspector(SupersedingEventEnablerQueryInspector calendarEnablerQueryInspector) Gets a superseding event enabler query from an inspector.
SupersedingEventEnablerSearchOrder	getSupersedingEventEnablerSearchOrder() Gets a superseding event enabler search order.
SupersedingEventEnablerQueryInspector	inspectSupersedingEventEnablerQuery() Gets a superseding 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.

getSupersedingEventEnablerQuery

SupersedingEventEnablerQuery getSupersedingEventEnablerQuery()

Gets a superseding event enabler query.

Returns:

the superseding event enabler query

Compliance:

mandatory - This method must be implemented.

getSupersedingEventEnablerSearchOrder

SupersedingEventEnablerSearchOrder getSupersedingEventEnablerSearchOrder()

Gets a superseding event enabler search order.

Returns:

the superseding event enabler search order

Compliance:

mandatory - This method must be implemented.

applySupersedingEventEnablerQuery

void applySupersedingEventEnablerQuery(SupersedingEventEnablerQuery calendarEnablerQuery)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Applies a superseding event enabler query to this calendar.

Parameters:

calendarEnablerQuery - the superseding event enabler query

Throws:

NullArgumentException - calendarEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - calendarEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectSupersedingEventEnablerQuery

SupersedingEventEnablerQueryInspector inspectSupersedingEventEnablerQuery()
                                                                          throws OperationFailedException,
                                                                                 PermissionDeniedException

Gets a superseding event enabler query inspector for this calendar.

Returns:

the superseding event enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySupersedingEventEnablerSequencing

void applySupersedingEventEnablerSequencing(SupersedingEventEnablerSearchOrder calendarEnablerSearchOrder)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Applies a superseding event enabler search order to this calendar.

Parameters:

calendarEnablerSearchOrder - the superseding event enabler search order

Throws:

NullArgumentException - calendarEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - calendarEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSupersedingEventEnablerQueryFromInspector

SupersedingEventEnablerQuery getSupersedingEventEnablerQueryFromInspector(SupersedingEventEnablerQueryInspector calendarEnablerQueryInspector)

Gets a superseding event enabler query from an inspector.

Parameters:

calendarEnablerQueryInspector - a superseding event enabler query inspector

Returns:

the superseding event enabler query

Throws:

NullArgumentException - calendarEnablerQueryInspector is null

UnsupportedException - calendarEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.