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

This session defines methods to receive notifications on adds/changes to StepProcessor objects in this Office. This also includes existing StepProcessors 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 StepProcessorLookupSession.

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

Tests if this user can register for StepProcessor 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 in office 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.
MethodreliableStepProcessorNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeStepProcessorNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableStepProcessorNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeStepProcessorNotification
Description

Acknowledge a step processor notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewStepProcessors
Description

Register for notifications of new step processors. StepProcessorReceiver.newStepProcessors() is invoked when a new StepProcessor appears in this office.

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

Registers for notification of updated office. StepProcessorReceiver.changedStepProcessors() is invoked when a step processor in this office is changed.

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

Registers for notification of an updated step processor. ProvisionableReceiver.changedStepProcessors() is invoked when the specified step processor in this office is changed.

Parametersosid.id.IdstepProcessorIdthe Id of the StepProcessor to monitor
ErrorsNULL_ARGUMENT stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedStepProcessors
Description

Registers for notification of deleted step processors. StepProcessorReceiver.deletedStepProcessors() is invoked when a step processor is deleted or removed from this office.

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

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

Parametersosid.id.IdstepProcessorIdthe Id of the StepProcessor to monitor
ErrorsNULL_ARGUMENT stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.