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

This session defines methods to receive asynchronous notifications on adds/changes to CyclicTimePeriods. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the CyclicTimePeriodLookupSession.

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

Tests if this user can register for CyclicTimePeriod notifications. 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 notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCalendarView
Description

Federates the view for methods in this session. A federated view will include notifications for cyclic time periods in calendars which are children of this calendar in the calendar hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCalendarView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this calendar only.

CompliancemandatoryThis method is must be implemented.
MethodreliableCyclicTimePeriodNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeCyclicTimePeriodNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableCyclicTimePeriodNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCyclicTimePeriodNotification
Description

Acknowledge a cyclic time period notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCyclicTimePeriods
Description

Register for notifications of new cyclic time periods. CyclicTimePeriodReceiver.newCyclicTimePeriods() is invoked when a new cyclic time period is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCyclicTimePeriods
Description

Registers for notification of updated cyclic time periods. CyclicTimePeriodReceiver.changedCyclicTimePeriods() is invoked when a cyclic time period is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCyclicTimePeriod
Description

Registers for notification of an updated cyclic time period. CyclicTimePeriodReceiver.changedCyclicTimePeriods() is invoked when the specified cyclic time period is changed.

Parametersosid.id.IdcyclicTimePeriodIdthe Id of the CyclicTimePeriod to monitor
ErrorsNULL_ARGUMENT cyclicTimePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCyclicTimePeriods
Description

Registers for notification of deleted cyclic time periods. CyclicTimePeriodReceiver.deletedCyclicTimePeriods() is invoked when a cyclic time period is removed from this calendar.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCyclicTimePeriod
Description

Registers for notification of a deleted cyclic time period. CyclicTimePeriodReceiver.changedCyclicTimePeriods() is invoked when the specified cyclic time period is removed from this calendar.

Parametersosid.id.IdcyclicTimePeriodIdthe Id of the CyclicTimePeriod to monitor
ErrorsNULL_ARGUMENT cyclicTimePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.