OSID - osid.workflow.WorkflowEventNotificationSession Service Interface Definition

Interface	osid.workflow.WorkflowEventNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `WorkflowEvent` objects in this `Process.` 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	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	useFederatedOfficeView
Description	Federates the view for methods in this session. A federated view will include events 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	canRegisterForWorkflowEventNotifications
Description	Tests if this user can register for `WorkflowEvent` 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	registerForNewWorkflowEvents
Description	Register for notifications of new workflow events. `WorkflowEventReceiver.newWorkflowEvents()` is invoked when a new `WorkflowEvent` appears in this process.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewWorkflowEventsForProcess
Description	Register for notifications of new workflow events for the given process. `WorkflowEventReceiver.newWorkflowEvents()` is invoked when a new `WorkflowEvent` appears in this process.
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process` to monitor
Errors	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewWorkflowEventsForStep
Description	Register for notifications of new workflow events for the given step. `WorkflowEventReceiver.newWorkflowEvents()` is invoked when a new `WorkflowEvent` appears in this process.
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step` to monitor
Errors	NULL_ARGUMENT		`stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewWorkflowEventsForWork
Description	Register for notifications of new workflow events for the given work. `WorkflowEventReceiver.newWorkflowEvents()` is invoked when a new `WorkflowEvent` appears in this process.
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	registerForNewWorkflowEventsForWorker
Description	Register for notifications of new workflow events for the given resource. `WorkflowEventReceiver.newWorkflowEvents()` is invoked when a new `WorkflowEvent` appears in this process.
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.