OSID - osid.calendaring.rules.CommitmentEnablerNotificationSession Service Interface Definition

Interface	osid.calendaring.rules.CommitmentEnablerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `CommitmentEnabler` objects in this `Calendar`. This also includes existing `CommitmentEnablers` 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 `CommitmentEnablerLookupSession`.
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForCommitmentEnablerNotifications
Description	Tests if this user can register for `CommitmentEnabler` 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 enablers 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	reliableCommitmentEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCommitmentEnablerNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCommitmentEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCommitmentEnablerNotification
Description	Acknowledge a commitment enabler 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	registerForNewCommitmentEnablers
Description	Register for notifications of new commitment enablers. `CommitmentEnablerReceiver.newCommitmentEnablers()` is invoked when a new `CommitmentEnabler` appears in this calendar.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCommitmentEnablers
Description	Registers for notification of updated calendar enablers. `CommitmentEnablerReceiver.changedCommitmentEnablers()` is invoked when a commitment enabler in this calendar is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCommitmentEnabler
Description	Registers for notification of an updated commitment enabler. `CommitmentEnablerReceiver.changedCommitmentEnablers()` is invoked when the specified commitment enabler in this calendar is changed.
Parameters	`osid.id.Id`	`commitmentEnablerId`	the `Id` of the `CommitmentEnabler` to monitor
Errors	NULL_ARGUMENT		`commitmentEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCommitmentEnablers
Description	Registers for notification of deleted commitment enablers. `CommitmentEnablerReceiver.deletedCommitmentEnablers()` is invoked when a commitment enabler is deleted or removed from this calendar.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCommitmentEnabler
Description	Registers for notification of a deleted commitment enabler. `CommitmentEnablerReceiver.deletedCommitmentEnablers()` is invoked when the specified commitment enabler is deleted or removed from this calendar.
Parameters	`osid.id.Id`	`commitmentEnablerId`	the `Id` of the `CommitmentEnabler` to monitor
Errors	NULL_ARGUMENT		`commitmentEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.