OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.ScheduleSlotSmartCalendarSession
Implementsosid.OsidSession
Description

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.

MethodgetCalendarId
Description

Gets the Calendar Id associated with this session.

Returnosid.id.Idthe Calendar Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCalendar
Description

Gets the Calendar associated with this session.

Returnosid.calendaring.Calendarthe Calendar associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartCalendars
Description

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.

Returnboolean false if smart calendar methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetScheduleSlotQuery
Description

Gets a schedule slot query.

Returnosid.calendaring.ScheduleSlotQuerythe schedule slot query
CompliancemandatoryThis method must be implemented.
MethodgetScheduleSlotSearchOrder
Description

Gets a schedule slot search order.

Returnosid.calendaring.ScheduleSlotSearchOrderthe schedule slot search order
CompliancemandatoryThis method must be implemented.
MethodapplyScheduleSlotQuery
Description

Applies a schedule slot query to this calendar.

Parametersosid.calendaring.ScheduleSlotQueryscheduleSlotQuerythe schedule slot query
ErrorsNULL_ARGUMENT scheduleSlotQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED scheduleSlotQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectScheduleSlotQuery
Description

Gets a schedule slot query inspector for this calendar.

Returnosid.calendaring.ScheduleSlotQueryInspectorthe schedule slot query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyScheduleSlotSequencing
Description

Applies a schedule slot search order to this calendar.

Parametersosid.calendaring.ScheduleSlotSearchOrderscheduleSlotSearchOrderthe schedule slot search order
ErrorsNULL_ARGUMENT scheduleSlotSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED scheduleSlotSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetScheduleSlotQueryFromInspector
Description

Gets a schedule slot query from an inspector.

Parametersosid.calendaring.ScheduleSlotQueryInspectorscheduleSlotQueryInspectora schedule slot query inspector
Returnosid.calendaring.ScheduleSlotQuerythe schedule slot query
ErrorsNULL_ARGUMENT scheduleSlotQueryInspector is null
UNSUPPORTED scheduleSlotQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.