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

This session manages queries and sequencing to create "smart" dynamic catalogs. An OffsetEventQuery can be retrieved from this session and mapped to this Calendar to create a virtual collection of OffsetEvents. The entries may be sequenced using the OffsetEventSearchOrder from this session.

This Calendar has a default query that matches any offset event and a default search order that specifies no sequencing. The queries may be examined using an OffsetEventQueryInspector. The query may be modified by converting the inspector back to an OffsetEventQuery.

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.
MethodgetOffsetEventQuery
Description

Gets an offset event query.

Returnosid.calendaring.OffsetEventQuerythe offset event query
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventSearchOrder
Description

Gets an offset event search order.

Returnosid.calendaring.OffsetEventSearchOrderthe offset event search order
CompliancemandatoryThis method must be implemented.
MethodapplyOffsetEventQuery
Description

Applies an offset event query to this calendar.

Parametersosid.calendaring.OffsetEventQueryoffsetEventQuerythe offset event query
ErrorsNULL_ARGUMENT offsetEventQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED offsetEventQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectOffsetEventQuery
Description

Gets an offset event query inspector for this calendar.

Returnosid.calendaring.OffsetEventQueryInspectorthe offset event query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyOffsetEventSequencing
Description

Applies an offset event search order to this calendar.

Parametersosid.calendaring.OffsetEventSearchOrderoffsetEventSearchOrderthe offset event search order
ErrorsNULL_ARGUMENT offsetEventSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED offsetEventSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventQueryFromInspector
Description

Gets an offset event query from an inspector.

Parametersosid.calendaring.OffsetEventQueryInspectoroffsetEventQueryInspectoran offset event query inspector
Returnosid.calendaring.OffsetEventQuerythe offset event query
ErrorsNULL_ARGUMENT offsetEventQueryInspector is null
UNSUPPORTED offsetEventQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.