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

This session provides methods to apply StepProcessors to Steps.

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

Tests if this user can alter step processor/step 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.
MethodassignStepProcessorToStep
Description

Adds an existing StepProcessor to a Step.

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

Removes a StepProcessor from a Step.

Parametersosid.id.IdstepProcessorIdthe Id of the StepProcessor
osid.id.IdstepIdthe Id of the Step
ErrorsNOT_FOUND stepProcessorId or stepId not found or stepProcessorId not applied to stepId
NULL_ARGUMENT stepProcessorId or stepId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceStepProcessors
Description

Tests if this user can order StepProcessors. 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 StepProcessor ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveStepProcessorAhead
Description

Reorders step processors for a step by moving the specified step processors in front of a reference step processors.

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

Reorders step processors for a step by moving the specified step processors behind a reference step processors.

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

Reorders a set of step processors for a step.

Parametersosid.id.Id[]stepProcessorIdsthe Ids for a set of StepProcessors
osid.id.IdstepIdthe Id of a Step
ErrorsNOT_FOUND stepId not found or, an stepProcessorId not related to stepId
NULL_ARGUMENT stepProcessorIds or stepId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.