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

This session defines methods to receive asynchronous notifications on adds/changes to SupersedingEvent objects. 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 views defined in this session correspond to the views in the SupersedingEventLookupSession.

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

Tests if this user can register for SupersedingEvent 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 events 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.
MethodreliableSupersedingEventNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableSupersedingEventNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeSupersedingEventNotification
Description

Acknowledge a superseding event notification.

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

Register for notifications of new superseding events. SupersedingEventReceiver.newSupersedingEvents() is invoked when a new superseding event is created.

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

Registers for notification of updated superseding events. SupersedingEventReceiver.changedSupersedingEvents() is invoked when a superseding event is changed.

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

Registers for notification of an updated superseding event. SupersedingEventReceiver.changedSupersedingEvents() is invoked when the specified superseding event is changed.

Parametersosid.id.IdsupersedingEventIdthe Id of the Superseding to monitor
ErrorsNULL_ARGUMENT supersedingEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSupersedingEvents
Description

Registers for notification of deleted superseding events. SupersedingEventReceiver.deletedSupersedingEvents() is invoked when a superseding event is removed from this calendar.

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

Registers for notification of a deleted superseding event. SupersedingEventReceiver.changedSupersedingEvents() is invoked when the specified superseding event is removed from this calendar.

Parametersosid.id.IdsupersedingEventIdthe Id of the Superseding to monitor
ErrorsNULL_ARGUMENT supersedingEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.