org.osid.calendaring.cycle

Interface CyclicTimePeriodSmartCalendarSession

All Superinterfaces:

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

public interface CyclicTimePeriodSmartCalendarSession
extends OsidSession

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

This Calendar has a default query that matches any cyclic time period and a default search order that specifies no sequencing. The queries may be examined using a CyclicTimePeriodQueryInspector. The query may be modified by converting the inspector back to a CyclicTimePeriodQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCyclicTimePeriodQuery(CyclicTimePeriodQuery cyclicTimePeriodQuery) Applies a cyclic time period query to this calendar.
void	applyCyclicTimePeriodSequencing(CyclicTimePeriodSearchOrder cyclicTimePeriodSearchOrder) Applies a cyclic time period 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.
CyclicTimePeriodQuery	getCyclicTimePeriodQuery() Gets a cyclic time period query.
CyclicTimePeriodQuery	getCyclicTimePeriodQueryFromInspector(CyclicTimePeriodQueryInspector cyclicTimePeriodQueryInspector) Gets a cyclic time period query from an inspector.
CyclicTimePeriodSearchOrder	getCyclicTimePeriodSearchOrder() Gets a cyclic time period search order.
CyclicTimePeriodQueryInspector	inspectCyclicTimePeriodQuery() Gets a cyclic time period 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.

getCyclicTimePeriodQuery

CyclicTimePeriodQuery getCyclicTimePeriodQuery()

Gets a cyclic time period query.

Returns:

the cyclic time period query

Compliance:

mandatory - This method must be implemented.

getCyclicTimePeriodSearchOrder

CyclicTimePeriodSearchOrder getCyclicTimePeriodSearchOrder()

Gets a cyclic time period search order.

Returns:

the cyclic time period search order

Compliance:

mandatory - This method must be implemented.

applyCyclicTimePeriodQuery

void applyCyclicTimePeriodQuery(CyclicTimePeriodQuery cyclicTimePeriodQuery)
                                throws OperationFailedException,
                                       PermissionDeniedException

Applies a cyclic time period query to this calendar.

Parameters:

cyclicTimePeriodQuery - the cyclic time period query

Throws:

NullArgumentException - cyclicTimePeriodQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - cyclicTimePeriodQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCyclicTimePeriodQuery

CyclicTimePeriodQueryInspector inspectCyclicTimePeriodQuery()
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Gets a cyclic time period query inspector for this calendar.

Returns:

the cyclic time period query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCyclicTimePeriodSequencing

void applyCyclicTimePeriodSequencing(CyclicTimePeriodSearchOrder cyclicTimePeriodSearchOrder)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Applies a cyclic time period search order to this calendar.

Parameters:

cyclicTimePeriodSearchOrder - the cyclic time period search order

Throws:

NullArgumentException - cyclicTimePeriodSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - cyclicTimePeriodSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCyclicTimePeriodQueryFromInspector

CyclicTimePeriodQuery getCyclicTimePeriodQueryFromInspector(CyclicTimePeriodQueryInspector cyclicTimePeriodQueryInspector)

Gets a cyclic time period query from an inspector.

Parameters:

cyclicTimePeriodQueryInspector - a cyclic time period query inspector

Returns:

the cyclic time period query interface

Throws:

NullArgumentException - cyclicTimePeriodQueryInspector is null

UnsupportedException - cyclicTimePeriodQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.