OSID - osid.resourcing.FoundryNotificationSession Service Interface Definition

Interface	osid.resourcing.FoundryNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.ResourcingManager`
Used By	`osid.resourcing.ResourcingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Foundry` 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	canRegisterForFoundryNotifications
Description	Tests if this user can register for `Foundry` 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	reliableFoundryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeFoundryNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableFoundryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeFoundryNotification
Description	Acknowledge a foundry 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	registerForNewFoundries
Description	Register for notifications of new foundries. `FoundryReceiver.newFoundries()` is invoked when a new `Foundry` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFoundries
Description	Registers for notification of updated foundries. `FoundryReceiver.changedFoundries()` is invoked when a foundry is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFoundry
Description	Registers for notification of an updated foundry. `FoundryReceiver.changedFoundries()` is invoked when the specified foundry is changed.
Parameters	`osid.id.Id`	`foundryId`	the Id of the `Foundry` to monitor
Errors	NULL_ARGUMENT		`foundryId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFoundries
Description	Registers for notification of deleted foundries. `FoundryReceiver.deletedFoundries()` is invoked when a foundry is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFoundry
Description	Registers for notification of a deleted foundry. `FoundryReceiver.deletedFoundries()` is invoked when the specified foundry is deleted.
Parameters	`osid.id.Id`	`foundryId`	the `Id` of the `Foundry` to monitor
Errors	NULL_ARGUMENT		`foundryId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFoundryHierarchy
Description	Registers for notification of an updated foundry hierarchy structure. `FoundryReceiver.changedChildOfFoundries()` is invoked when the specified node or any of its descendants 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	registerForChangedFoundryHierarchyForAncestors
Description	Registers for notification of an updated foundry hierarchy structure. `FoundryReceiver.changedChildOfFoundries()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`foundryId`	the `Id` of the `Foundry` node to monitor
Errors	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFoundryHierarchyForDescendants
Description	Registers for notification of an updated foundry hierarchy structure. `FoundryReceiver.changedChildOfFoundries()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`foundryId`	the `Id` of the `Foundry` node to monitor
Errors	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.