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

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

This Calendar has a default query that matches any cyclic time period and a default search order that specifies no sequencing. The queries may be examined using a CyclicTimePeriodQueryInspector. The query may be modified by converting the inspector back to a CyclicTimePeriodQuery.

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

Gets a cyclic time period query.

Returnosid.calendaring.cycle.CyclicTimePeriodQuerythe cyclic time period query
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodSearchOrder
Description

Gets a cyclic time period search order.

Returnosid.calendaring.cycle.CyclicTimePeriodSearchOrderthe cyclic time period search order
CompliancemandatoryThis method must be implemented.
MethodapplyCyclicTimePeriodQuery
Description

Applies a cyclic time period query to this calendar.

Parametersosid.calendaring.cycle.CyclicTimePeriodQuerycyclicTimePeriodQuerythe cyclic time period query
ErrorsNULL_ARGUMENT cyclicTimePeriodQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED cyclicTimePeriodQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectCyclicTimePeriodQuery
Description

Gets a cyclic time period query inspector for this calendar.

Returnosid.calendaring.cycle.CyclicTimePeriodQueryInspectorthe cyclic time period query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyCyclicTimePeriodSequencing
Description

Applies a cyclic time period search order to this calendar.

Parametersosid.calendaring.cycle.CyclicTimePeriodSearchOrdercyclicTimePeriodSearchOrderthe cyclic time period search order
ErrorsNULL_ARGUMENT cyclicTimePeriodSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED cyclicTimePeriodSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodQueryFromInspector
Description

Gets a cyclic time period query from an inspector.

Parametersosid.calendaring.cycle.CyclicTimePeriodQueryInspectorcyclicTimePeriodQueryInspectora cyclic time period query inspector
Returnosid.calendaring.cycle.CyclicTimePeriodQuerythe cyclic time period query interface
ErrorsNULL_ARGUMENT cyclicTimePeriodQueryInspector is null
UNSUPPORTED cyclicTimePeriodQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.