org.osid.calendaring

Interface ScheduleSmartCalendarSession

All Superinterfaces:

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

public interface ScheduleSmartCalendarSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyScheduleQuery(ScheduleQuery scheduleQuery) Applies a schedule query to this calendar.
void	applyScheduleSequencing(ScheduleSearchOrder scheduleSearchOrder) Applies a schedule 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.
ScheduleQuery	getScheduleQuery() Gets a schedule query.
ScheduleQuery	getScheduleQueryFromInspector(ScheduleQueryInspector scheduleQueryInspector) Gets a schedule query from an inspector.
ScheduleSearchOrder	getScheduleSearchOrder() Gets a schedule search order.
ScheduleQueryInspector	inspectScheduleQuery() Gets a schedule 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.

getScheduleQuery

ScheduleQuery getScheduleQuery()

Gets a schedule query.

Returns:

the schedule query

Compliance:

mandatory - This method must be implemented.

getScheduleSearchOrder

ScheduleSearchOrder getScheduleSearchOrder()

Gets a schedule search order.

Returns:

the schedule search order

Compliance:

mandatory - This method must be implemented.

applyScheduleQuery

void applyScheduleQuery(ScheduleQuery scheduleQuery)
                        throws OperationFailedException,
                               PermissionDeniedException

Applies a schedule query to this calendar.

Parameters:

scheduleQuery - the schedule query

Throws:

NullArgumentException - scheduleQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - scheduleQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectScheduleQuery

ScheduleQueryInspector inspectScheduleQuery()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets a schedule query inspector for this calendar.

Returns:

the schedule query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyScheduleSequencing

void applyScheduleSequencing(ScheduleSearchOrder scheduleSearchOrder)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a schedule search order to this calendar.

Parameters:

scheduleSearchOrder - the schedule search order

Throws:

NullArgumentException - scheduleSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - scheduleSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getScheduleQueryFromInspector

ScheduleQuery getScheduleQueryFromInspector(ScheduleQueryInspector scheduleQueryInspector)

Gets a schedule query from an inspector.

Parameters:

scheduleQueryInspector - a schedule query inspector

Returns:

the schedule query

Throws:

NullArgumentException - scheduleQueryInspector is null

UnsupportedException - scheduleQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.