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

This session provides methods to retrieve ProcessEnabler to Office mappings. A ProcessEnabler may appear in multiple Office objects. Each office may have its own authorizations governing who is allowed to look at it.

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
MethodcanLookupProcessEnablerOfficeMappings
Description

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

A complete view of the ProcessEnabler and Office 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.
MethodgetProcessEnablerIdsByOffice
Description

Gets the list of ProcessEnablerIds associated with an Office.

Parametersosid.id.IdofficeId Id of the Office
Returnosid.id.IdListlist of related process enabler Ids
ErrorsNOT_FOUND officeId is not found
NULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablersByOffice
Description

Gets the list of process enabler associated with an Office.

Parametersosid.id.IdofficeId Id of the Office
Returnosid.workflow.rules.ProcessEnablerListlist of related process enablers
ErrorsNOT_FOUND officeId is not found
NULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablerIdsByOffices
Description

Gets the list of ProcessEnabler Ids corresponding to a list of Offices.

Parametersosid.id.IdListofficeIdslist of office Ids
Returnosid.id.IdListlist of process enabler Ids
ErrorsNULL_ARGUMENT officeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablersByOffices
Description

Gets the list of process enabler corresponding to a list of Offices.

Parametersosid.id.IdListofficeIdslist of office Ids
Returnosid.workflow.rules.ProcessEnablerListlist of process enablers
ErrorsNULL_ARGUMENT officeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfficeIdsByProcessEnabler
Description

Gets the Office Ids mapped to a ProcessEnabler.

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

Gets the Offices mapped to a ProcessEnabler.

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