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

This session provides methods to retrieve StepConstrainer to Office mappings. a StepConstrainer 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
MethodcanLookupStepConstrainerOfficeMappings
Description

Tests if this user can perform lookups of step constrainer/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.
MethoduseComparativeStepConstrainerOfficeView
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.
MethodusePlenaryStepConstrainerOfficeView
Description

A complete view of the StepConstrainer 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.
MethodgetStepConstrainerIdsByOffice
Description

Gets the list of StepConstrainerIds associated with an Office.

Parametersosid.id.IdofficeId Id of the Office
Returnosid.id.IdListlist of related step constrainer 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.
MethodgetStepConstrainersByOffice
Description

Gets the list of step constrainer associated with an Office.

Parametersosid.id.IdofficeId Id of the Office
Returnosid.workflow.rules.StepConstrainerListlist of related step constrainers
ErrorsNOT_FOUND officeId is not found
NULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerIdsByOffices
Description

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

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

Gets the list of step constrainer corresponding to a list of Offices.

Parametersosid.id.IdListofficeIdslist of office Ids
Returnosid.workflow.rules.StepConstrainerListlist of step constrainers
ErrorsNULL_ARGUMENT officeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfficeIdsByStepConstrainer
Description

Gets the Office Ids mapped to a StepConstrainer.

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

Gets the Offices mapped to a StepConstrainer.

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