OSID - osid.hold.BlockNotificationSession Service Interface Definition

Interface	osid.hold.BlockNotificationSession
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 `Block` objects in this `Oubliette`. This also includes existing blocks that may appear or disappear due to changes in the `Oubliette` 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 `BlockLookupSession`.
Method	getOublietteId
Description	Gets the `Oubliette` `Id` associated with this session.
Return	`osid.id.Id`		the `Oubliette Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOubliette
Description	Gets the `Oubliette` associated with this session.
Return	`osid.hold.Oubliette`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForBlockNotifications
Description	Tests if this user can register for `Block` 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	useFederatedOublietteView
Description	Federates the view for methods in this session. A federated view will include blocks in oubliettes which are children of this oubliette in the oubliette hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOublietteView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this oubliette only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableBlockNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeBlockNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableBlockNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeBlockNotification
Description	Acknowledge a block 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	registerForNewBlocks
Description	Register for notifications of new blocks. `BlockReceiver.newBlocks()` is invoked when a new `Block` appears in this oubliette.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBlocks
Description	Registers for notification of updated blocks. `BlockReceiver.changedBlocks()` is invoked when a block in this oubliette is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBlock
Description	Registers for notification of an updated block. `BlockReceiver.changedBlocks()` is invoked when the specified block in this oubliette is changed.
Parameters	`osid.id.Id`	`blockId`	the `Id` of the `Block` to monitor
Errors	NOT_FOUND		a block was not found in this oubliette identified by the given `Id`
	NULL_ARGUMENT		`blockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBlocks
Description	Registers for notification of deleted blocks. `BlockReceiver.deletedBlocks()` is invoked when a block is deleted or removed from this oubliette.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBlock
Description	Registers for notification of a deleted block. `BlockReceiver.deletedBlocks()` is invoked when the specified block is deleted or removed from this oubliette.
Parameters	`osid.id.Id`	`blockId`	the `Id` of the `Block` to monitor
Errors	NOT_FOUND		a block was not found identified by the given `Id`
	NULL_ARGUMENT		`blockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.