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

This session provides methods to apply StepConstrainerEnablers to StepConstrainers. a StepConstrainer with multiple StepConstrainerEnablers means any positive rule evaluation across the enablers result in an effective StepConstrainer.

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

Tests if this user can alter step constrainer enabler/step constrainer 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.
MethodassignStepConstrainerEnablerToStepConstrainer
Description

Adds an existing StepConstrainerEnabler to a StepConstrainer.

Parametersosid.id.IdstepConstrainerEnablerIdthe Id of the StepConstrainerEnabler
osid.id.IdstepConstrainerIdthe Id of the StepConstrainer
ErrorsALREADY_EXISTS stepConstrainerEnablerId is already applied to stepConstrainerId
NOT_FOUND stepConstrainerEnablerId or stepConstrainerId not found
NULL_ARGUMENT stepConstrainerEnablerId or stepConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignStepConstrainerEnablerFromStepConstrainer
Description

Removes a StepConstrainerEnabler from a StepConstrainer.

Parametersosid.id.IdstepConstrainerEnablerIdthe Id of the StepConstrainerEnabler
osid.id.IdstepConstrainerIdthe Id of the StepConstrainer
ErrorsNOT_FOUND stepConstrainerEnablerId or stepConstrainerId not found or stepConstrainerEnablerId not applied to stepConstrainerId
NULL_ARGUMENT stepConstrainerEnablerId or stepConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceStepConstrainerEnablers
Description

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

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

Parametersosid.id.IdstepConstrainerEnablerIdthe Id of a StepConstrainerEnabler
osid.id.IdstepConstrainerIdthe Id of a StepConstrainer
osid.id.IdreferenceIdthe reference step constrainer enabler Id
ErrorsNOT_FOUND stepConstrainerEnablerId, stepConstrainerId, or referenceId not found or, stepConstrainerEnablerId or referenceId not related to stepConstrainerId
NULL_ARGUMENT stepConstrainerEnablerId, stepConstrainerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveStepConstrainerEnablerBehind
Description

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

Parametersosid.id.IdstepConstrainerEnablerIdthe Id of a StepConstrainerEnabler
osid.id.IdstepConstrainerIdthe Id of a StepConstrainer
osid.id.IdreferenceIdthe reference step constrainer enabler Id
ErrorsNOT_FOUND stepConstrainerEnablerId, stepConstrainerId, or referenceId not found or, stepConstrainerEnablerId or referenceId not related to stepConstrainerId
NULL_ARGUMENT stepConstrainerEnablerId, stepConstrainerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderStepConstrainerEnablers
Description

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

Parametersosid.id.Id[]stepConstrainerEnablerIdsthe Ids for a set of StepConstrainerEnablers
osid.id.IdstepConstrainerIdthe Id of a StepConstrainer
ErrorsNOT_FOUND stepConstrainerId not found or, an stepConstrainerEnablerId not related to stepConstrainerId
NULL_ARGUMENT stepConstrainerEnablerIds or stepConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.