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

This session provides methods to retrieve ProcessEnabler to Process mappings. A Process with multiple ProcessEnablers means any positive rule evaluation across the constrainers result in an accessible Process.

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

Tests if this user can perform lookups of process enabler/process 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.
MethoduseComparativeProcessEnablerRuleView
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.
MethodusePlenaryProcessEnablerRuleView
Description

A complete view of the ProcessEnabler and Process 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 process enabler 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.
MethodgetProcessEnablerIdsForProcess
Description

Gets the ProcessEnabler Id associated with a Process.

Parametersosid.id.IdprocessId Id of the Process
Returnosid.id.IdListthe process enabler Ids
ErrorsNOT_FOUND processId is not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablersForProcess
Description

Gets the ProcessEnabler associated with a Process.

Parametersosid.id.IdprocessId Id of the Process
Returnosid.workflow.rules.ProcessEnablerListthe process enablers
ErrorsNOT_FOUND processId is not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessIdsForProcessEnabler
Description

Gets the Process Ids mapped to a ProcessEnabler.

Parametersosid.id.IdprocessEnablerId Id of a ProcessEnabler
Returnosid.id.IdListlist of process Ids
ErrorsNOT_FOUND processEnablerId is not found
NULL_ARGUMENT processEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcesssForProcessEnabler
Description

Gets the Processs mapped to a ProcessEnabler.

Parametersosid.id.IdprocessEnablerId Id of a ProcessEnabler
Returnosid.workflow.ProcessListlist of processs
ErrorsNOT_FOUND processEnablerId is not found
NULL_ARGUMENT processEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.