OSID - osid.resourcing.EffortNotificationSession Service Interface Definition

Interface	osid.resourcing.EffortNotificationSession
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 `Effort` objects in this `Foundry` . This also includes existing efforts 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 `EffortLookupSession` .
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	canRegisterForEffortNotifications
Description	Tests if this user can register for `Effort` 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 efforts 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	reliableEffortNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeEffortNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableEffortNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeEffortNotification
Description	Acknowledge an effort 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	registerForNewEfforts
Description	Register for notifications of new efforts. `EffortReceiver.newEfforts()` is invoked when a new `Effort` appears in this foundry.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEffortsForResource
Description	Register for notifications of new efforts for the given resource `Id` . `EffortReceiver.newEfforts()` is invoked when a new `Effort` 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	registerForNewEffortsForCommission
Description	Register for notifications of new efforts for the given commission `Id` . `EffortReceiver.newEfforts()` is invoked when a new `Effort` is created.
Parameters	`osid.id.Id`	`commissionId`	the `Id` of the commission to monitor
Errors	NULL_ARGUMENT		`commissionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEffortsForWork
Description	Register for notifications of new efforts for the given work `Id` . `EffortReceiver.newEfforts()` is invoked when a new `Effort` is created.
Parameters	`osid.id.Id`	`workId`	the `Id` of the work to monitor
Errors	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEfforts
Description	Registers for notification of updated efforts. `EffortReceiver.changedEfforts()` is invoked when an effort 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	registerForChangedEffortsForResource
Description	Register for notifications of updated efforts for the given resource `Id` . `EffortReceiver.changedEfforts()` is invoked when an effort in this foundry 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	registerForChangedEffortsForCommission
Description	Register for notifications of updated efforts for the given commission `Id` . `EffortReceiver.changedEfforts()` is invoked when an effort in this foundry is changed.
Parameters	`osid.id.Id`	`commissionId`	the `Id` of the commission to monitor
Errors	NULL_ARGUMENT		`commissionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEffortsForWork
Description	Register for notifications of updated efforts for the given work `Id` . `EffortReceiver.changedEfforst()` is invoked when an effort in this foundry is changed.
Parameters	`osid.id.Id`	`workId`	the `Id` of the work to monitor
Errors	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEffort
Description	Registers for notification of an updated effort. `EffortReceiver.changedEfforts()` is invoked when the specified effort in this foundry is changed.
Parameters	`osid.id.Id`	`effortId`	the `Id` of the `Effort` to monitor
Errors	NULL_ARGUMENT		`effortId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEfforts
Description	Registers for notification of deleted efforts. `EffortReceiver.deletedEfforts()` is invoked when an effort 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	registerForDeletedEffortsForResource
Description	Register for notifications of deleted efforts for the given resource `Id` . `EffortReceiver.deletedEfforts()` is invoked when an effort in this foundry is removed or deleted.
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	registerForDeletedEffortsForCommission
Description	Register for notifications of deleted efforts for the given commission `Id` . `EffortReceiver.deletedEfforts()` is invoked when an effort in this foundry is removed or deleted.
Parameters	`osid.id.Id`	`commissionId`	the `Id` of the commission to monitor
Errors	NULL_ARGUMENT		`commissionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEffortsForWork
Description	Register for notifications of deleted efforts for the given work `Id` . `EffortReceiver.deletedEfforts()` is invoked when an effort in this foundry is removed or deleted.
Parameters	`osid.id.Id`	`workId`	the `Id` of the work to monitor
Errors	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEffort
Description	Registers for notification of a deleted effort. `EffortReceiver.deletedEfforts()` is invoked when the specified effort is deleted or removed from this foundry.
Parameters	`osid.id.Id`	`effortId`	the `Id` of the `Effort` to monitor
Errors	NULL_ARGUMENT		`effortId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.