OSID - osid.resourcing.rules.JobConstrainerNotificationSession Service Interface Definition

Interface	osid.resourcing.rules.JobConstrainerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `JobConstrainer` objects in this `Foundry` . This also includes existing `JobConstrainers` that may appear or disappear due to changes in the `Foundry` 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 `JobConstrainerLookupSession` .
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForJobConstrainerNotifications
Description	Tests if this user can register for `JobConstrainer` 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	useFederatedFoundryView
Description	Federates the view for methods in this session. A federated view will include in foundries which are children of this foundry in the foundry hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFoundryView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this foundry only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableJobConstrainerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeJobConstrainerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableJobConstrainerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeJobConstrainerNotification
Description	Acknowledge a job constrainer 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	registerForNewJobConstrainers
Description	Register for notifications of new job constrainers. `JobConstrainerReceiver.newJobConstrainers()` is invoked when a new `JobConstrainer` appears in this foundry.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedJobConstrainers
Description	Registers for notification of updated foundries. `JobConstrainerReceiver.changedJobConstrainers()` is invoked when a job constrainer in this foundry is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedJobConstrainer
Description	Registers for notification of an updated job constrainer. `ProvisionableReceiver.changedJobConstrainers()` is invoked when the specified job constrainer in this foundry is changed.
Parameters	`osid.id.Id`	`jobConstrainerId`	the `Id` of the `JobConstrainer` to monitor
Errors	NULL_ARGUMENT		`jobConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedJobConstrainers
Description	Registers for notification of deleted job constrainers. `JobConstrainerReceiver.deletedJobConstrainers()` is invoked when a job constrainer is deleted or removed from this foundry.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedJobConstrainer
Description	Registers for notification of a deleted job constrainer. `JobConstrainerReceiver.deletedJobConstrainers()` is invoked when the specified job constrainer is deleted or removed from this foundry.
Parameters	`osid.id.Id`	`jobConstrainerId`	the `Id` of the `JobConstrainer` to monitor
Errors	NULL_ARGUMENT		`jobConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.