org.osid.calendaring

Interface TimePeriodSmartCalendarSession

All Superinterfaces:

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

public interface TimePeriodSmartCalendarSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A TimePeriodQuery 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 TimePeriodSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyTimePeriodQuery(TimePeriodQuery timePeriodQuery) Applies a time period query to this calendar.
void	applyTimePeriodSequencing(TimePeriodSearchOrder timePeriodSearchOrder) Applies a 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.
TimePeriodQuery	getTimePeriodQuery() Gets a time period query.
TimePeriodQuery	getTimePeriodQueryFromInspector(TimePeriodQueryInspector timePeriodQueryInspector) Gets a time period query from an inspector.
TimePeriodSearchOrder	getTimePeriodSearchOrder() Gets a time period search order.
TimePeriodQueryInspector	inspectTimePeriodQuery() Gets a 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.

getTimePeriodQuery

TimePeriodQuery getTimePeriodQuery()

Gets a time period query.

Returns:

the time period query

Compliance:

mandatory - This method must be implemented.

getTimePeriodSearchOrder

TimePeriodSearchOrder getTimePeriodSearchOrder()

Gets a time period search order.

Returns:

the time period search order

Compliance:

mandatory - This method must be implemented.

applyTimePeriodQuery

void applyTimePeriodQuery(TimePeriodQuery timePeriodQuery)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a time period query to this calendar.

Parameters:

timePeriodQuery - the time period query

Throws:

NullArgumentException - timePeriodQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - timePeriodQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectTimePeriodQuery

TimePeriodQueryInspector inspectTimePeriodQuery()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets a time period query inspector for this calendar.

Returns:

the time period query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyTimePeriodSequencing

void applyTimePeriodSequencing(TimePeriodSearchOrder timePeriodSearchOrder)
                               throws OperationFailedException,
                                      PermissionDeniedException

Applies a time period search order to this calendar.

Parameters:

timePeriodSearchOrder - the time period search order

Throws:

NullArgumentException - timePeriodSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - timePeriodSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getTimePeriodQueryFromInspector

TimePeriodQuery getTimePeriodQueryFromInspector(TimePeriodQueryInspector timePeriodQueryInspector)

Gets a time period query from an inspector.

Parameters:

timePeriodQueryInspector - a time period query inspector

Returns:

the time period query interface

Throws:

NullArgumentException - timePeriodQueryInspector is null

UnsupportedException - timePeriodQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.