OSID - osid.calendaring.CommitmentNotificationSession Service Interface Definition

Interface	osid.calendaring.CommitmentNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive asynchronous notifications on adds/changes to event commitments. 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 `CommitmentLookupSession.`
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	canRegisterForCommitmentNotifications
Description	Tests if this user can register for `Commitment` 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 commitments 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	reliableCommitmentNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCommitmentNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCommitmentNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCommitmentNotification
Description	Acknowledge a commitment 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	registerForNewCommitments
Description	Register for notifications of new commitments. `CommitmentReceiver.newCommitments()` is invoked when a new commitment is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCommitmentsByGenusType
Description	Register for notifications of new commitments by commitment genus type. `CommitmentReceiver.newCommitments()` is invoked when a new commitment is created.
Parameters	`osid.id.Id`	`commitmentGenusType`	the commitment genus type to monitor
Errors	NULL_ARGUMENT		`commitmentGenusType is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCommitmentsForEvent
Description	Register for notifications of new commitments for the given event. `CommitmentReceiver.newCommitments()` is invoked when a new commitment is created.
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	registerForNewCommitmentsForResource
Description	Register for notifications of new commitments for the given resource. `CommitmentReceiver.newCommitments()` is invoked when a new commitment is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCommitments
Description	Registers for notification of updated commitments. `CommitmentReceiver.changedCommitments()` is invoked when a commitment is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCommitmentsByGenusType
Description	Register for notifications of changed commitments by commitment genus type. `CommitmentReceiver.changedCommitments()` is invoked when a commitment is changed.
Parameters	`osid.type.Type`	`commitmentGenusType`	the commitment genus type to monitor
Errors	NULL_ARGUMENT		`commitmentGenusType is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCommitmentsForEvent
Description	Register for notifications of changed commitments for the given event. `CommitmentReceiver.changedCommitments()` is invoked when a commitment 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	registerForChangedCommitmentsForResource
Description	Register for notifications of changed commitments for the given rsource. `CommitmentReceiver.changedCommitments()` is invoked when a commitment is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCommitment
Description	Registers for notification of an updated commitment. `CommitmentReceiver.changedCommitments()` is invoked when the specified commitment is changed.
Parameters	`osid.id.Id`	`commitmentId`	the `Id` of the `Commitment` to monitor
Errors	NULL_ARGUMENT		`commitmentId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCommitments
Description	Registers for notification of deleted commitments. `CommitmentReceiver.deletedCommitments()` is invoked when a commitment is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCommitmentsByGenusType
Description	Register for notifications of deleted commitments by commitment genus type. `CommitmentReceiver.deletedCommitments()` is invoked when a commitment is deleted.
Parameters	`osid.id.Id`	`commitmentGenusType`	the commitment genus type to monitor
Errors	NULL_ARGUMENT		`commitmentGenusType is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCommitmentsForEvent
Description	Register for notifications of deleted commitments for the given event. `CommitmentReceiver.deletedCommitments()` is invoked when a commitment is deleted.
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	registerForDeletedCommitmentsForResource
Description	Register for notifications of deleted commitments for the given rsource. `CommitmentReceiver.deletedCommitments()` is invoked when a commitment is deleted.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCommitment
Description	Registers for notification of a deleted commitment. `CommitmentReceiver.changedCommitments()` is invoked when the specified commitment is deleted.
Parameters	`osid.id.Id`	`commitmentId`	the `Id` of the `Commitment` to monitor
Errors	NULL_ARGUMENT		`commitmentId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.