OSID - osid.calendaring.EventNotificationSession Service Interface Definition

Interface	osid.calendaring.EventNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive asynchronous notifications on adds/changes to `Event` 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 `EventLookupSession.`
Method	getCalendarId
Description	Gets the `Calendar` `Id` associated with this session.
Return	`osid.id.Id`		the `Calendar Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendar
Description	Gets the `Calendar` associated with this session.
Return	`osid.calendaring.Calendar`		the `Calendar` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForEventNotifications
Description	Tests if this user can register for `Event` 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.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCalendarView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCalendarView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this calendar only.
Compliance	`mandatory`		This method is must be implemented.
Method	useNormalizedEventView
Description	A normalized view sends a single notification for recurring events.
Compliance	`mandatory`		This method is must be implemented.
Method	useDenormalizedEventView
Description	A denormalized view sends a separate notification for each non-recurring event within a recurring set.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableEventNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeEventNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableEventNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeEventNotification
Description	Acknowledge an event notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEvents
Description	Register for notifications of new events. `EventReceiver.newEvents()` is invoked when a new event is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEvents
Description	Registers for notification of updated events. `EventReceiver.changedEvents()` is invoked when an event is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEvent
Description	Registers for notification of an updated event. `EventReceiver.changedEvents()` is invoked when the specified event is changed.
Parameters	`osid.id.Id`	`eventId`	the `Id` of the `Event` to monitor
Errors	NULL_ARGUMENT		`eventId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEvents
Description	Registers for notification of deleted events. `EventReceiver.deletedEvents()` is invoked when an event is removed from this calendar.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEvent
Description	Registers for notification of a deleted event. `EventReceiver.changedEvents()` is invoked when the specified event is removed from this calendar.
Parameters	`osid.id.Id`	`eventId`	the `Id` of the `Event` to monitor
Errors	NULL_ARGUMENT		`eventId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.