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

This session provides methods to apply StepProcessorEnablers to StepProcessors. a StepProcessor with multiple StepProcessorEnablers means any positive rule evaluation across the enablers result in an effective StepProcessor.

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

Tests if this user can alter step processor enabler/step processor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignStepProcessorEnablerToStepProcessor
Description

Adds an existing StepProcessorEnabler to a StepProcessor.

Parametersosid.id.IdstepProcessorEnablerIdthe Id of the StepProcessorEnabler
osid.id.IdstepProcessorIdthe Id of the StepProcessor
ErrorsALREADY_EXISTS stepProcessorEnablerId is already applied to stepProcessorId
NOT_FOUND stepProcessorEnablerId or stepProcessorId not found
NULL_ARGUMENT stepProcessorEnablerId or stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignStepProcessorEnablerFromStepProcessor
Description

Removes a StepProcessorEnabler from a StepProcessor.

Parametersosid.id.IdstepProcessorEnablerIdthe Id of the StepProcessorEnabler
osid.id.IdstepProcessorIdthe Id of the StepProcessor
ErrorsNOT_FOUND stepProcessorEnablerId or stepProcessorId not found or stepProcessorEnablerId not applied to stepProcessorId
NULL_ARGUMENT stepProcessorEnablerId or stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceStepProcessorEnablers
Description

Tests if this user can order StepProcessorEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if StepProcessorEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveStepProcessorEnablerAhead
Description

Reorders step processor enablers for a step processor by moving the specified step processor enabler in front of a reference step processor enabler.

Parametersosid.id.IdstepProcessorEnablerIdthe Id of a StepProcessorEnabler
osid.id.IdstepProcessorIdthe Id of a StepProcessor
osid.id.IdreferenceIdthe reference step processor enabler Id
ErrorsNOT_FOUND stepProcessorEnablerId, stepProcessorId, or referenceId not found or, stepProcessorEnablerId or referenceId not related to stepProcessorId
NULL_ARGUMENT stepProcessorEnablerId, stepProcessorId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveStepProcessorEnablerBehind
Description

Reorders step processor enablers for a step processor by moving the specified step processor enabler behind a reference step processor enabler.

Parametersosid.id.IdstepProcessorEnablerIdthe Id of a StepProcessorEnabler
osid.id.IdstepProcessorIdthe Id of a StepProcessor
osid.id.IdreferenceIdthe reference step processor enabler Id
ErrorsNOT_FOUND stepProcessorEnablerId, stepProcessorId, or referenceId not found or, stepProcessorEnablerId or referenceId not related to stepProcessorId
NULL_ARGUMENT stepProcessorEnablerId, stepProcessorId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderStepProcessorEnablers
Description

Reorders a set of step processor enablers for a step processor.

Parametersosid.id.Id[]stepProcessorEnablerIdsthe Ids for a set of StepProcessorEnablers
osid.id.IdstepProcessorIdthe Id of a StepProcessor
ErrorsNOT_FOUND stepProcessorId not found or, an stepProcessorEnablerId not related to stepProcessorId
NULL_ARGUMENT stepProcessorEnablerIds or stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.