OSID - osid.hold.HoldNotificationSession Service Interface Definition

Interface	osid.hold.HoldNotificationSession
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 `Hold` objects in this `Oubliette`. This also includes existing holds 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 `HoldLookupSession`.
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	canRegisterForHoldNotifications
Description	Tests if this user can register for `Hold` 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 holds 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	reliableHoldNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeHoldNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableHoldNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeHoldNotification
Description	Acknowledge a hold 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	registerForNewHolds
Description	Register for notifications of new holds. `HoldReceiver.newHolds()` is invoked when a new `Hold` appears in this oubliette.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewHoldsForResource
Description	Register for notifications of new holds for the given resource `Id` including any holds for agents related to the resource. `HoldReceiver.newHolds()` is invoked when a new `Hold` 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	registerForNewHoldsForIssue
Description	Register for notifications of new holds for the given issue `Id`. `HoldReceiver.newHolds()` is invoked when a new `Hold` is created.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the issue to monitor
Errors	NULL_ARGUMENT		`issueid` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedHolds
Description	Registers for notification of updated holds. `HoldReceiver.changedHolds()` is invoked when a hold 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	registerForChangedHoldsForResource
Description	Register for notifications of updated holds for the given resource `Id` including any holds for agents related to the resource. `HoldReceiver.changedHolds()` is invoked when a `Hold` in this oubliette 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	registerForChangedHoldsForIssue
Description	Register for notifications of updated holds for the given issue `Id`. `HoldReceiver.changedHolds()` is invoked when a `Hold` in this oubliette is changed.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the issue to monitor
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedHold
Description	Registers for notification of an updated hold. `HoldReceiver.changedHolds()` is invoked when the specified hold in this oubliette is changed.
Parameters	`osid.id.Id`	`holdId`	the `Id` of the `Hold` to monitor
Errors	NOT_FOUND		a hold was not found in this oubliette identified by the given `Id`
	NULL_ARGUMENT		`holdId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedHolds
Description	Registers for notification of deleted holds. `HoldReceiver.deletedHolds()` is invoked when a hold 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	registerForDeletedHoldsForResource
Description	Register for notifications of deleted holds for the given resource `Id` including any holds for agents related to the resource. `HoldReceiver.deletedHolds()` is invoked when a `Hold` is deleted or removed from this oubliette.
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	registerForDeletedHoldsForIssue
Description	Register for notifications of deleted holds for the given issue `Id`. `HoldReceiver.deletedHolds()` is invoked when a `Hold` is deleted or removed from this oubliette.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the issue to monitor
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedHold
Description	Registers for notification of a deleted hold. `HoldReceiver.deletedHolds()` is invoked when the specified hold is deleted or removed from this oubliette.
Parameters	`osid.id.Id`	`holdId`	the `Id` of the `Hold` to monitor
Errors	NOT_FOUND		a hold was not found identified by the given `Id`
	NULL_ARGUMENT		`holdId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.