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

This session provides methods to retrieve StepConstrainer to Step mappings. A Step with multiple StepConstrainers means any positive rule evaluation across the constrainers result in an accessible Step.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated office view: All methods in this session operate, retrieve and pertain step constrainer defined explicitly in the current office
  • federated office view: All methods in this session operate, retrieve and pertain to all step constrainer defined in this office and any other step constrainer implicitly available in this office through office inheritence.
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.
MethodcanLookupStepConstrainerRules
Description

Tests if this user can perform lookups of step constrainer/step mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeStepConstrainerRuleView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryStepConstrainerRuleView
Description

A complete view of the StepConstrainer and Step returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedOfficeView
Description

Federates the view for methods in this session. A federated view will include step constrainer 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 lookups to this office only.

CompliancemandatoryThis method is must be implemented.
MethodgetStepConstrainerIdsForStep
Description

Gets the StepConstrainer Id associated with a Step.

Parametersosid.id.IdstepId Id of the Step
Returnosid.id.IdListthe step constrainer Ids
ErrorsNOT_FOUND stepId is not found
NULL_ARGUMENT stepId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainersForStep
Description

Gets the StepConstrainer associated with a Step.

Parametersosid.id.IdstepId Id of the Step
Returnosid.workflow.rules.StepConstrainerListthe step constrainers
ErrorsNOT_FOUND stepId is not found
NULL_ARGUMENT stepId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepIdsForStepConstrainer
Description

Gets the Step Ids mapped to a StepConstrainer.

Parametersosid.id.IdstepConstrainerId Id of a StepConstrainer
Returnosid.id.IdListlist of step Ids
ErrorsNOT_FOUND stepConstrainerId is not found
NULL_ARGUMENT stepConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepsForStepConstrainer
Description

Gets the Steps mapped to a StepConstrainer.

Parametersosid.id.IdstepConstrainerId Id of a StepConstrainer
Returnosid.workflow.StepListlist of steps
ErrorsNOT_FOUND stepConstrainerId is not found
NULL_ARGUMENT stepConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.