org.osid.calendaring

Interface SupersedingEventSmartCalendarSession

All Superinterfaces:

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

public interface SupersedingEventSmartCalendarSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A SupersedingEventQuery can be retrieved from this session and mapped to this Calendar to create a virtual collection of SupersedingEvents. The entries may be sequenced using the SupersedingEventSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applySupersedingEventQuery(SupersedingEventQuery supersedingEventQuery) Applies a superseding event query to this calendar.
void	applySupersedingEventSequencing(SupersedingEventSearchOrder supersedingEventSearchOrder) Applies a superseding 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.
SupersedingEventQuery	getSupersedingEventQuery() Gets a superseding event query.
SupersedingEventQuery	getSupersedingEventQueryFromInspector(SupersedingEventQueryInspector supersedingEventQueryInspector) Gets a superseding event query from an inspector.
SupersedingEventSearchOrder	getSupersedingEventSearchOrder() Gets a superseding event search order.
SupersedingEventQueryInspector	inspectSupersedingEventQuery() Gets a superseding event 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 associated with this session

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 all 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 smart operations.

Returns:

false if smart calendar methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getSupersedingEventQuery

SupersedingEventQuery getSupersedingEventQuery()

Gets a superseding event query.

Returns:

the superseding event query

Compliance:

mandatory - This method must be implemented.

getSupersedingEventSearchOrder

SupersedingEventSearchOrder getSupersedingEventSearchOrder()

Gets a superseding event search order.

Returns:

the superseding event search order

Compliance:

mandatory - This method must be implemented.

applySupersedingEventQuery

void applySupersedingEventQuery(SupersedingEventQuery supersedingEventQuery)
                                throws OperationFailedException,
                                       PermissionDeniedException

Applies a superseding event query to this calendar.

Parameters:

supersedingEventQuery - the superseding event query

Throws:

NullArgumentException - supersedingEventQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - supersedingEventQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectSupersedingEventQuery

SupersedingEventQueryInspector inspectSupersedingEventQuery()
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Gets a superseding event query inspector for this calendar.

Returns:

the superseding event query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySupersedingEventSequencing

void applySupersedingEventSequencing(SupersedingEventSearchOrder supersedingEventSearchOrder)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Applies a superseding event search order to this calendar.

Parameters:

supersedingEventSearchOrder - the superseding event search order

Throws:

NullArgumentException - supersedingEventSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - supersedingEventSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSupersedingEventQueryFromInspector

SupersedingEventQuery getSupersedingEventQueryFromInspector(SupersedingEventQueryInspector supersedingEventQueryInspector)

Gets a superseding event query from an inspector.

Parameters:

supersedingEventQueryInspector - a superseding event query inspector

Returns:

the superseding event query

Throws:

NullArgumentException - supersedingEventQueryInspector is null

UnsupportedException - supersedingEventQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.