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

This session provides methods for retrieving Step objects. The Step represents a fixed connection between two Availabilities.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated office view: All step methods in this session operate, retrieve and pertain to steps defined explicitly in the current office. Using an isolated view is useful for managing Steps with the StepAdminSession.
  • federated office view: All step methods in this session operate, retrieve and pertain to all steps defined in this office and any other steps implicitly available in this office through office inheritence.
  • active step view: active steps are returned from methods in this session
  • any status step view: active and inactive steps are returned from methods in this session

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedOfficeView() and useIsolatedOfficeView() behave as a radio group and one should be selected before invoking any lookup methods.

MethodgetOfficeId
Description

Gets the Office Id associated with this session.

Returnosid.id.Idthe Office Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOffice
Description

Gets the Office associated with this session.

Returnosid.workflow.Officethe office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupSteps
Description

Tests if this user can perform Step lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeStepView
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.
MethodusePlenaryStepView
Description

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

Federates the view for methods in this session. A federated view will include steps in offices which are children of this office in the office hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOfficeView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this office only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveStepView
Description

Only active steps are returned from methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusStepView
Description

Borth active and inactive steps are returned from methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetStep
Description

Gets the Step specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Step may have a different Id than requested, such as the case where a duplicate Id was assigned to a Step and retained for compatibility.

In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.

Parametersosid.id.IdstepId Id of the Step
Returnosid.workflow.Stepthe step
ErrorsNOT_FOUND stepId not found
NULL_ARGUMENT stepId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetStepsByIds
Description

Gets a StepList corresponding to the given IdList.

In plenary mode, the returned list contains all of the steps specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Steps may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.

Parametersosid.id.IdListstepIdsthe list of Ids to retrieve
Returnosid.workflow.StepListthe returned Step list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT stepIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepsByGenusType
Description

Gets a StepList corresponding to the given step genus Type which does not include steps of genus types derived from the specified Type.

In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session.

In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.

Parametersosid.type.TypestepGenusTypea step genus type
Returnosid.workflow.StepListthe returned Step list
ErrorsNULL_ARGUMENT stepGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepsByParentGenusType
Description

Gets a StepList corresponding to the given step genus Type and include any additional steps with genus types derived from the specified Type.

In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session.

In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.

Parametersosid.type.TypestepGenusTypea step genus type
Returnosid.workflow.StepListthe returned Step list
ErrorsNULL_ARGUMENT stepGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepsByRecordType
Description

Gets a StepList containing the given step record Type.

In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session.

In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.

Parametersosid.type.TypestepRecordTypea step record type
Returnosid.workflow.StepListthe returned Step list
ErrorsNULL_ARGUMENT stepRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepsByProvider
Description

Gets a StepList from the given provider.

In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session.

In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.

Parametersosid.id.IdresourceIda resource Id
Returnosid.workflow.StepListthe returned Step list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepsForProcess
Description

Gets a list of steps by process.

In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session.

In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.

Parametersosid.id.IdprocessIda process Id
Returnosid.workflow.StepListthe returned Step list
ErrorsNULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepsByState
Description

Gets a list of steps for which the given state is valid. The steps returned are the states specified in the previous step or the process.

In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session.

In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.

Parametersosid.id.IdstateIda stateId Id
Returnosid.workflow.StepListthe returned Step list
ErrorsNULL_ARGUMENT stateId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSteps
Description

Gets all Steps.

In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session.

In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.

Returnosid.workflow.StepLista list of Steps
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.