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

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

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

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

Gets a recurring event query.

Returnosid.calendaring.RecurringEventQuerythe recurring event query
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventSearchOrder
Description

Gets a recurring event search order.

Returnosid.calendaring.RecurringEventSearchOrderthe recurring event search order
CompliancemandatoryThis method must be implemented.
MethodapplyRecurringEventQuery
Description

Applies a recurring event query to this calendar.

Parametersosid.calendaring.RecurringEventQueryrecurringEventQuerythe recurring event query
ErrorsNULL_ARGUMENT recurringEventQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED recurringEventQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRecurringEventQuery
Description

Gets a recurring event query inspector for this calendar.

Returnosid.calendaring.RecurringEventQueryInspectorthe recruring event query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRecurringEventSequencing
Description

Applies a recurring event search order to this calendar.

Parametersosid.calendaring.RecurringEventSearchOrderrecurringEventSearchOrderthe recurring event search order
ErrorsNULL_ARGUMENT recurringEventSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED recurringEventSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventQueryFromInspector
Description

Gets a recurring event query from an inspector.

Parametersosid.calendaring.RecurringEventQueryInspectorrecurringEventQueryInspectora recurring event query inspector
Returnosid.calendaring.RecurringEventQuerythe recurring event query
ErrorsNULL_ARGUMENT recruringEventQueryInspector is null
UNSUPPORTED recurringEventQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.