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

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

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

A complete view of the StepProcessor 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.
MethodgetStepProcessorIdsByOffice
Description

Gets the list of StepProcessorIds associated with an Office.

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

Gets the list of step processors associated with an Office.

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

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

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

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

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

Gets the Office Ids mapped to a StepProcessor.

Parametersosid.id.IdstepProcessorId Id of a StepProcessor
Returnosid.id.IdListlist of offices
ErrorsNOT_FOUND stepProcessorId is not found
NULL_ARGUMENT stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfficesByStepProcessor
Description

Gets the Offices mapped to a StepProcessor.

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