OSID - osid.hold.OublietteNotificationSession Service Interface Definition

Interface	osid.hold.OublietteNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.hold.HoldManager`
Used By	`osid.hold.HoldProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Oubliette` 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.
Method	canRegisterForOublietteNotifications
Description	Tests if this user can register for `Oubliette` 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	reliableOublietteNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeOublietteNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableOublietteNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeOublietteNotification
Description	Acknowledge an oubliette 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	registerForNewOubliettes
Description	Register for notifications of new oubliettes. `OublietteReceiver.newOubliettes()` is invoked when a new `Oubliette` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOubliettes
Description	Registers for notification of updated oubliettes. `OublietteReceiver.changedOubliettes()` is invoked when an oubliette is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOubliette
Description	Registers for notification of an updated oubliette. `OublietteReceiver.changedOubliettes()` is invoked when the specified oubliette is changed.
Parameters	`osid.id.Id`	`oublietteId`	the Id of the `Oubliette` to monitor
Errors	NOT_FOUND		an oubliette was not found identified by the given `Id`
	NULL_ARGUMENT		`oublietteId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOubliettes
Description	Registers for notification of deletedoOubliettes. `OublietteReceiver.deletedOubliettes()` is invoked when an oubliette is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOubliette
Description	Registers for notification of a deleted oubliette. `OublietteReceiver.deletedOubliettes()` is invoked when the specified oubliette is deleted.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette` to monitor
Errors	NOT_FOUND		an oubliette was not found identified by the given `Id`
	NULL_ARGUMENT		`oublietteId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOublietteHierarchy
Description	Registers for notification of an updated oubliette hierarchy structure. `OublietteReceiver.changedChildOfOubliettes()` 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	registerForChangedOublietteHierarchyForAncestors
Description	Oubliette `Receiver.changedChildOfOubliettes()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette` node to monitor
Errors	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOublietteHierarchyForDescendants
Description	Registers for notification of an updated oubliette hierarchy structure. `OublietteReceiver.changedChildOfOubliettes()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette` node to monitor
Errors	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.