OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Interfaceosid.workflow.rules.ProcessConstrainerEnablerOfficeSession
Implementsosid.OsidSession
Used Byosid.workflow.rules.WorkflowRulesManager
osid.workflow.rules.WorkflowRulesProxyManager
Description

This session provides methods to retrieve ProcessConstrainerEnabler to Office mappings. A ProcessConstrainerEnabler may appear in multiple Offices. 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
MethodcanLookupProcessConstrainerEnablerOfficeMappings
Description

Tests if this user can perform lookups of process constrainer 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. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnbooleanfalse if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeProcessConstrainerEnablerOfficeView
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.
MethodusePlenaryProcessConstrainerEnablerOfficeView
Description

A complete view of the ProcessConstrainerEnabler 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.
MethodgetProcessConstrainerEnablerIdsByOffice
Description

Gets the list of ProcessConstrainerEnablerIds associated with an Office .

Parametersosid.id.IdofficeIdId of the Office
Returnosid.id.IdListlist of related process constrainer enabler Ids
ErrorsNOT_FOUNDofficeId is not found
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessConstrainerEnablersByOffice
Description

Gets the list of ProcessConstrainerEnablers associated with an Office .

Parametersosid.id.IdofficeIdId of the Office
Returnosid.workflow.rules.ProcessConstrainerEnablerListlist of related process constrainer enablers
ErrorsNOT_FOUNDofficeId is not found
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessConstrainerEnablerIdsByOffices
Description

Gets the list of ProcessConstrainerEnablerIds corresponding to a list of Offices .

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

Gets the list of ProcessConstrainerEnablers corresponding to a list of Offices .

Parametersosid.id.IdListofficeIdslist of office Ids
Returnosid.workflow.rules.ProcessConstrainerEnablerListlist of process constrainer enablers
ErrorsNULL_ARGUMENTofficeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfficeIdsByProcessConstrainerEnabler
Description

Gets the Office Ids mapped to a ProcessConstrainerEnabler .

Parametersosid.id.IdprocessConstrainerEnablerIdId of a ProcessConstrainerEnabler
Returnosid.id.IdListlist of office Ids
ErrorsNOT_FOUNDprocessConstrainerEnablerId is not found
NULL_ARGUMENTprocessConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfficesByProcessConstrainerEnabler
Description

Gets the Offices mapped to a ProcessConstrainerEnabler .

Parametersosid.id.IdprocessConstrainerEnablerIdId of a ProcessConstrainerEnabler
Returnosid.workflow.OfficeListlist of offices
ErrorsNOT_FOUNDprocessConstrainerEnablerId is not found
NULL_ARGUMENTprocessConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.