OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.StepNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Step objects 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.

MethodgetOfficeId
Description

Gets the Office Id associated with this session.

Returnosid.id.Idthe Office Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOffice
Description

Gets the Office associated with this session.

Returnosid.workflow.Officethe office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForStepNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedOfficeView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOfficeView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this office only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewSteps
Description

Register for notifications of new steps. StepReceiver.newSteps() is invoked when a new Step appears in this office.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewStepsForProcess
Description

Register for notifications of new steps in the given process Id. StepReceiver.newSteps() is invoked when a new Step is created.

Parametersosid.id.IdprocessIdthe Id of the process to monitor
ErrorsNULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedSteps
Description

Registers for notification of updated steps. StepReceiver.changedSteps() is invoked when a step in this office is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedStepsForProcess
Description

Register for notifications of updated steps for the given process Id. StepReceiver.changedSteps() is invoked when a step in this office is changed.

Parametersosid.id.IdprocessIdthe Id of the process to monitor
ErrorsNULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedStep
Description

Registers for notification of an updated step. StepReceiver.changedSteps() is invoked when the specified step in this office is changed.

Parametersosid.id.IdstepIdthe Id of the Step to monitor
ErrorsNULL_ARGUMENT stepId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSteps
Description

Registers for notification of deleted steps. StepReceiver.deletedSteps() is invoked when a step is deleted or removed from this office.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedStepsForProcess
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.

Parametersosid.id.IdprocessIdthe Id of the process to monitor
ErrorsNULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedStep
Description

Registers for notification of a deleted step. StepReceiver.deletedSteps() is invoked when the specified step is deleted or removed from this office.

Parametersosid.id.IdstepIdthe Id of the Step to monitor
ErrorsNULL_ARGUMENT stepId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.