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

This session provides methods to retrieve Step to Office workflows. A Step 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
MethodcanLookupStepOfficeMappings
Description

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

A complete view of the Step 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.
MethodgetStepIdsByOffice
Description

Gets the list of Step Ids associated with a Office.

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

Gets the list of Steps associated with a Office.

Parametersosid.id.IdofficeId Id of the Office
Returnosid.workflow.StepListlist of related steps
ErrorsNOT_FOUND officeId is not found
NULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepIdsByOffices
Description

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

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

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

Parametersosid.id.IdListofficeIdslist of office Ids
Returnosid.workflow.StepListlist of steps
ErrorsNULL_ARGUMENT officeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfficeIdsByStep
Description

Gets the Office Ids mapped to a Step.

Parametersosid.id.IdstepId Id of a Step
Returnosid.id.IdListlist of offices
ErrorsNOT_FOUND stepId is not found
NULL_ARGUMENT stepId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfficesByStep
Description

Gets the Offices mapped to a Step.

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