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

This session provides methods for retrieving StepProcessors.

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 processor methods in this session operate, retrieve and pertain to step processor defined explicitly in the current office. Using an isolated view is useful for managing StepProcessors with the StepProcessorAdminSession.
  • federated office view: All step processor methods in this session operate, retrieve and pertain to all step processor defined in this office and any other step processor implicitly available in this office through office inheritence.
  • active step processor view: All step processor lookup methods return active step processors.
  • any status step processor view: Step processors of any active or inactive status are returned from methods.

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 the methods in this session.

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.
MethodcanLookupStepProcessors
Description

Tests if this user can perform StepProcessors 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.
MethoduseComparativeStepProcessorView
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.
MethodusePlenaryStepProcessorView
Description

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

Only active step processors are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusStepProcessorView
Description

All active and inactive step processors enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetStepProcessor
Description

Gets the StepProcessor specified by its Id.

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

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

Parametersosid.id.IdstepProcessorId Id of the StepProcessor
Returnosid.workflow.rules.StepProcessorthe step processor
ErrorsNOT_FOUND stepProcessorId not found
NULL_ARGUMENT stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetStepProcessorsByIds
Description

Gets a StepProcessorList corresponding to the given IdList.

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

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

Parametersosid.id.IdListstepProcessorIdsthe list of Ids to retrieve
Returnosid.workflow.rules.StepProcessorListthe returned StepProcessor list
ErrorsNOT_FOUNDa Id was not found
NULL_ARGUMENT stepProcessorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorsByGenusType
Description

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

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

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

Parametersosid.type.TypestepProcessorGenusTypea step processor genus type
Returnosid.workflow.rules.StepProcessorListthe returned StepProcessor list
ErrorsNULL_ARGUMENT stepProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorsByParentGenusType
Description

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

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

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

Parametersosid.type.TypestepProcessorGenusTypea step processor genus type
Returnosid.workflow.rules.StepProcessorListthe returned StepProcessor list
ErrorsNULL_ARGUMENT stepProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorsByRecordType
Description

Gets a StepProcessorList containing the given step processor record Type.

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

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

Parametersosid.type.TypestepProcessorRecordTypea step processor record type
Returnosid.workflow.rules.StepProcessorListthe returned StepProcessor list
ErrorsNULL_ARGUMENT stepProcessorRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessors
Description

Gets all StepProcessors.

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

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

Returnosid.workflow.rules.StepProcessorListthe returned StepProcessor list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.