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

This session provides methods for retrieving Process objects.

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 process methods in this session operate, retrieve and pertain to processes defined explicitly in the current office. Using an isolated view is useful for managing Process with the ProcessAdminSession.
  • federated office view: All process methods in this session operate, retrieve and pertain to all process defined in this office and any other process implicitly available in this office through office inheritence.
  • active process view: active processes are returned from methods in this session
  • any status process view: active and inactive processes 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.
MethodcanLookupProcesses
Description

Tests if this user can perform Process 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.
MethoduseComparativeProcessView
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.
MethodusePlenaryProcessView
Description

A complete view of the Process 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 processes 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.
MethoduseActiveProcessView
Description

Only active processes are returned from methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusProcessView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetProcess
Description

Gets the Process specified by its Id.

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

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

Parametersosid.id.IdprocessId Id of the Process
Returnosid.workflow.Processthe process
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetProcessesByIds
Description

Gets a ProcessList corresponding to the given IdList.

In plenary mode, the returned list contains all of the processes 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 Processes may be omitted from the list and may present the elements in any order including returning a unique set.

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

Parametersosid.id.IdListprocessIdsthe list of Ids to retrieve
Returnosid.workflow.ProcessListthe returned Process list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT processIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessesByGenusType
Description

Gets a ProcessList corresponding to the given process genus Type which does not include processes of genus types derived from the specified Type.

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

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

Parametersosid.type.TypeprocessGenusTypea process genus type
Returnosid.workflow.ProcessListthe returned Process list
ErrorsNULL_ARGUMENT processGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessesByParentGenusType
Description

Gets a ProcessList corresponding to the given process genus Type and include any additional processes with genus types derived from the specified Type.

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

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

Parametersosid.type.TypeprocessGenusTypea process genus type
Returnosid.workflow.ProcessListthe returned Process list
ErrorsNULL_ARGUMENT processGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessesByRecordType
Description

Gets a ProcessList containing the given process record Type.

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

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

Parametersosid.type.TypeprocessRecordTypea process record type
Returnosid.workflow.ProcessListthe returned Process list
ErrorsNULL_ARGUMENT processRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessesByProvider
Description

Gets a ProcessList from the given provider.

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

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

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

Gets all Processes.

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

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

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