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

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

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 processor enablers defined explicitly in the current office
  • federated office view: All methods in this session operate, retrieve and pertain to all step processor enablers defined in this office and any other step processor enablers 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.
MethodcanLookupStepProcessorEnablerRules
Description

Tests if this user can perform lookups of step processor enabler/step processor 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.
MethoduseComparativeStepProcessorEnablerRuleView
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.
MethodusePlenaryStepProcessorEnablerRuleView
Description

A complete view of the StepProcessorEnabler and StepProcessor 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 processor enablers 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.
MethodgetStepProcessorEnablerIdsForStepProcessor
Description

Gets the StepProcessorEnabler Id associated with a StepProcessor.

Parametersosid.id.IdstepProcessorId Id of the StepProcessor
Returnosid.id.IdListthe step processor enabler Ids
ErrorsNOT_FOUND stepProcessorId is not found
NULL_ARGUMENT stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorEnablersForStepProcessor
Description

Gets the StepProcessorEnabler associated with a StepProcessor.

Parametersosid.id.IdstepProcessorId Id of the StepProcessor
Returnosid.workflow.rules.StepProcessorEnablerListthe step processor enablers
ErrorsNOT_FOUND stepProcessorId is not found
NULL_ARGUMENT stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorIdsForStepProcessorEnabler
Description

Gets the StepProcessor Ids mapped to a StepProcessorEnabler.

Parametersosid.id.IdstepProcessorEnablerId Id of a StepProcessorEnabler
Returnosid.id.IdListlist of step processor Ids
ErrorsNOT_FOUND stepProcessorEnablerId is not found
NULL_ARGUMENT stepProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorsForStepProcessorEnabler
Description

Gets the StepProcessors mapped to a StepProcessorEnabler.

Parametersosid.id.IdstepProcessorEnablerId Id of a StepProcessorEnabler
Returnosid.workflow.rules.StepProcessorListlist of step processors
ErrorsNOT_FOUND stepProcessorEnablerId is not found
NULL_ARGUMENT stepProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.