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

This session defines methods to receive notifications on adds/changes to RecurringEventEnabler objects in this Calendar. This also includes existing RecirringEventEnablers that may appear or disappear due to changes in the Calendar hierarchy, 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 RecurringEventEnablerLookupSession.

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForRecurringEventEnablerNotifications
Description

Tests if this user can register for RecurringEventEnabler 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 enablers 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.
MethodreliableRecurringEventEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableRecurringEventEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeRecurringEventEnablerNotification
Description

Acknowledge a recurring event enabler notification.

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

Register for notifications of new offset event enablers. RecurringEventEnablerReceiver.newRecurringEventEnablers() is invoked when a new RecurringEventEnabler appears in this calendar.

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

Registers for notification of updated calendar enablers. RecurringEventEnablerReceiver.changedRecurringEventEnablers() is invoked when a recurring event enabler in this calendar is changed.

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

Registers for notification of an updated offset event enabler. RecurringEventEnablerReceiver.changedRecurringEventEnablers() is invoked when the specified offset event enabler in this calendar is changed.

Parametersosid.id.IdrecurringEventEnablerIdthe Id of the RecurringEventEnabler to monitor
ErrorsNULL_ARGUMENT recurringEventEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRecurringEventEnablers
Description

Registers for notification of deleted offset event enablers. RecurringEventEnablerReceiver.deletedRecurringEventEnablers() is invoked when an offset event enabler is deleted or removed from this calendar.

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

Registers for notification of a deleted offset event enabler. RecurringEventEnablerReceiver.deletedRecurringEventEnablers() is invoked when the specified offset event enabler is deleted or removed from this calendar.

Parametersosid.id.IdrecurringEventEnablerIdthe Id of the RecurringEventEnabler to monitor
ErrorsNULL_ARGUMENT recurringEventEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.