OSID - osid.workflow.StepNotificationSession Service Interface Definition

Interface	osid.workflow.StepNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.WorkflowManager`
Used By	`osid.workflow.WorkflowProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Steps` in this `Office` . This also includes existing steps 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 `StepLookupSession`.
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	canRegisterForStepNotifications
Description	Tests if this user can register for `Step` 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 steps 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	reliableStepNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeStepNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableStepNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeStepNotification
Description	Acknowledge a step 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	registerForNewSteps
Description	Register for notifications of new steps. `StepReceiver.newSteps()` is invoked when a new `Step` appears in this office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewStepsForProcess
Description	Register for notifications of new steps in the given process `Id`. `StepReceiver.newSteps()` is invoked when a new `Step` is created.
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	registerForChangedSteps
Description	Registers for notification of updated steps. `StepReceiver.changedSteps()` is invoked when a step 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	registerForChangedStepsForProcess
Description	Register for notifications of updated steps for the given process `Id`. `StepReceiver.changedSteps()` is invoked when a step in this office is changed.
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	registerForChangedStep
Description	Registers for notification of an updated step. `StepReceiver.changedSteps()` is invoked when the specified step in this office is changed.
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	registerForDeletedSteps
Description	Registers for notification of deleted steps. `StepReceiver.deletedSteps()` is invoked when a step 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	registerForDeletedStepsForProcess
Description	Register for notifications of deleted steps for the given process `Id`. `StepReceiver.deletedSteps()` is invoked when a step in this office is removed or deleted.
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	registerForDeletedStep
Description	Registers for notification of a deleted step. `StepReceiver.deletedSteps()` is invoked when the specified step is deleted or removed from this office.
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.