OSID - osid.workflow.WorkNotificationSession Service Interface Definition

Interface	osid.workflow.WorkNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Work` objects in this `Office.` This also includes existing works that may appear or disappear due to changes in the `Office` 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 `WorkLookupSession.`
Method	getOfficeId
Description	Gets the `Office` `Id` associated with this session.
Return	`osid.id.Id`		the `Office Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOffice
Description	Gets the `Office` associated with this session.
Return	`osid.workflow.Office`		the office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForWorkNotifications
Description	Tests if this user can register for `Work` 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	useFederatedOfficeView
Description	Federates the view for methods in this session. A federated view will include works in offices which are children of this office in the office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this office only.
Compliance	`mandatory`		This method is must be implemented.
Method	registerForNewWorks
Description	Register for notifications of new works. `WorkReceiver.newWorks()` is invoked when a new `Work` appears in this office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedWorks
Description	Registers for notification of updated works. `WorkReceiver.changedWorks()` is invoked when a work in this office is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedWork
Description	Registers for notification of an updated work. `WorkReceiver.changedWorks()` is invoked when the specified work in this office 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	registerForDeletedWorks
Description	Registers for notification of deleted works. `WorkReceiver.deletedWorks()` is invoked when a work is deleted or removed from this office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedWork
Description	Registers for notification of a deleted work. `WorkReceiver.deletedWorks()` is invoked when the specified work is deleted or removed from this office.
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.