OSID - osid.workflow.rules.StepEnablerNotificationSession Service Interface Definition

Interface	osid.workflow.rules.StepEnablerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `StepEnablers` in this `Office` . This also includes existing step enablers that may appear or disappear due to changes in the `Office hierarc` hy, 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 `StepEnablerLookupSession` .
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	canRegisterForStepEnablerNotifications
Description	Tests if this user can register for `StepEnabler` 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 step enablers 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	reliableStepEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeStepEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableStepEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeStepEnablerNotification
Description	Acknowledge a step enabler 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	registerForNewStepEnablers
Description	Register for notifications of new step enablers. `StepEnablerReceiver.newStepEnablers()` is invoked when a new `StepEnabler` appears in this office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedStepEnablers
Description	Register for notifications of updated step enablers. `StepEnablerReceiver.changedStepEnablers()` is invoked when a `StepEnabler` 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	registerForChangedStepEnabler
Description	Register for notifications of an updated step enabler. `StepEnablerReceiver.changedStepEnablers()` is invoked when the specified `StepEnabler` in this office is changed.
Parameters	`osid.id.Id`	`stepEnablerId`	the `Id` of the `StepEnabler` to monitor
Errors	NULL_ARGUMENT		`stepEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedStepEnablers
Description	Registers for notification of deleted step enablers. `StepEnablerReceiver.deletedStepEnablers()` is invoked when a step enabler 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	registerForDeletedStepEnabler
Description	Registers for notification of a deleted step enabler. `StepEnablerReceiver.deletedStepEnabler()` is invoked when the specified step enabler is deleted or removed from this office.
Parameters	`osid.id.Id`	`stepEnablerId`	the `Id` of the `StepEnabler` to monitor
Errors	NULL_ARGUMENT		`stepEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.