OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.WorkflowEventNotificationSession
Implementsosid.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.

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.
MethoduseFederatedOfficeView
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.

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.
MethodcanRegisterForWorkflowEventNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodregisterForNewWorkflowEvents
Description

Register for notifications of new workflow events. WorkflowEventReceiver.newWorkflowEvents() is invoked when a new WorkflowEvent appears in this process.

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

Register for notifications of new workflow events for the given process. WorkflowEventReceiver.newWorkflowEvents() is invoked when a new WorkflowEvent appears in this process.

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.
MethodregisterForNewWorkflowEventsForStep
Description

Register for notifications of new workflow events for the given step. WorkflowEventReceiver.newWorkflowEvents() is invoked when a new WorkflowEvent appears in this process.

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.
MethodregisterForNewWorkflowEventsForWork
Description

Register for notifications of new workflow events for the given work. WorkflowEventReceiver.newWorkflowEvents() is invoked when a new WorkflowEvent appears in this process.

Parametersosid.id.IdworkIdthe Id of the Work to monitor
ErrorsNULL_ARGUMENT workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewWorkflowEventsForWorker
Description

Register for notifications of new workflow events for the given resource. WorkflowEventReceiver.newWorkflowEvents() is invoked when a new WorkflowEvent appears in this process.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.