org.osid.calendaring

Interface ScheduleSlotSmartCalendarSession

All Superinterfaces:

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

public interface ScheduleSlotSmartCalendarSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyScheduleSlotQuery(ScheduleSlotQuery scheduleSlotQuery) Applies a schedule slot query to this calendar.
void	applyScheduleSlotSequencing(ScheduleSlotSearchOrder scheduleSlotSearchOrder) Applies a schedule slot 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.
ScheduleSlotQuery	getScheduleSlotQuery() Gets a schedule slot query.
ScheduleSlotQuery	getScheduleSlotQueryFromInspector(ScheduleSlotQueryInspector scheduleSlotQueryInspector) Gets a schedule slot query from an inspector.
ScheduleSlotSearchOrder	getScheduleSlotSearchOrder() Gets a schedule slot search order.
ScheduleSlotQueryInspector	inspectScheduleSlotQuery() Gets a schedule slot 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.

getScheduleSlotQuery

ScheduleSlotQuery getScheduleSlotQuery()

Gets a schedule slot query.

Returns:

the schedule slot query

Compliance:

mandatory - This method must be implemented.

getScheduleSlotSearchOrder

ScheduleSlotSearchOrder getScheduleSlotSearchOrder()

Gets a schedule slot search order.

Returns:

the schedule slot search order

Compliance:

mandatory - This method must be implemented.

applyScheduleSlotQuery

void applyScheduleSlotQuery(ScheduleSlotQuery scheduleSlotQuery)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a schedule slot query to this calendar.

Parameters:

scheduleSlotQuery - the schedule slot query

Throws:

NullArgumentException - scheduleSlotQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - scheduleSlotQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectScheduleSlotQuery

ScheduleSlotQueryInspector inspectScheduleSlotQuery()
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets a schedule slot query inspector for this calendar.

Returns:

the schedule slot query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyScheduleSlotSequencing

void applyScheduleSlotSequencing(ScheduleSlotSearchOrder scheduleSlotSearchOrder)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies a schedule slot search order to this calendar.

Parameters:

scheduleSlotSearchOrder - the schedule slot search order

Throws:

NullArgumentException - scheduleSlotSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - scheduleSlotSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getScheduleSlotQueryFromInspector

ScheduleSlotQuery getScheduleSlotQueryFromInspector(ScheduleSlotQueryInspector scheduleSlotQueryInspector)

Gets a schedule slot query from an inspector.

Parameters:

scheduleSlotQueryInspector - a schedule slot query inspector

Returns:

the schedule slot query

Throws:

NullArgumentException - scheduleSlotQueryInspector is null

UnsupportedException - scheduleSlotQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.