OSID - osid.calendaring.CalendarNotificationSession Service Interface Definition

Interface	osid.calendaring.CalendarNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Calendar` 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 i
Method	canRegisterForCalendarNotifications
Description	Tests if this user can register for `Calendar` 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	reliableCalendarNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCalendarNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCalendarNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCalendarNotification
Description	Acknowledge a clendar 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	registerForNewCalendars
Description	Register for notifications of new calendars. `CalendarReceiver.newCalendars()` is invoked when a new `Calendar` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCalendars
Description	Registers for notification of updated calendars. `CalendarReceiver.changedCalendars()` is invoked when a calendar is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCalendar
Description	Registers for notification of an updated calendar. `CalendarReceiver.changedCalendars()` is invoked when the specified calendar is changed.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar to monitor
Errors	NULL_ARGUMENT		`calendarId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCalendars
Description	Registers for notification of deleted calendars. `CalendarReceiver.deletedCalendars()` is invoked when a calenedar is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCalendar
Description	Registers for notification of a deleted calendar. `CalendarReceiver.deletedCalendars()` is invoked when the specified calendar is deleted.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar to monitor
Errors	NULL_ARGUMENT		`calendarId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCalendarHierarchy
Description	Registers for notification of an updated calendar hierarchy structure. `CalendarReceiver.changedChildOfCalendars()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCalendarHierarchyForAncestors
Description	Calendar `Receiver.changedChildOfCalendars()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar` node to monitor
Errors	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCalendarHierarchyForDescendants
Description	Registers for notification of an updated calendar hierarchy structure. `CalendarReceiver.changedChildOfCalendars()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar` node to monitor
Errors	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.