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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProcessQuery can be retrieved from this session and mapped to this Office to create a virtual collection of Processes. The process may be sequenced using the ProcessSearchOrder from this session.

This Office has a default query that matches any process and a default search order that specifies no sequencing. The queries may be examined using a ProcessQueryInspector. The query may be modified by converting the inspector back to a ProcessQuery.

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

Tests if this user can manage smart offices. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart office management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProcessQuery
Description

Gets a process query.

Returnosid.workflow.ProcessQuerythe process query
CompliancemandatoryThis method must be implemented.
MethodgetProcessSearchOrder
Description

Gets a process search order.

Returnosid.workflow.ProcessSearchOrderthe process search order
CompliancemandatoryThis method must be implemented.
MethodapplyProcessQuery
Description

Applies a process query to this office.

Parametersosid.workflow.ProcessQueryprocessQuerythe process query
ErrorsNULL_ARGUMENT processQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED processQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectProcessQuery
Description

Gets a process query inspector for this office.

Returnosid.workflow.ProcessQueryInspectorthe process query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyProcessSequencing
Description

Applies a process search order to this office.

Parametersosid.workflow.ProcessSearchOrderprocessSearchOrderthe process search order
ErrorsNULL_ARGUMENT processSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED processSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProcessQueryFromInspector
Description

Gets a process query from an inspector.

Parametersosid.workflow.ProcessQueryInspectorprocessQueryInspectora process query inspector
Returnosid.workflow.ProcessQuerythe process query
ErrorsNULL_ARGUMENT processQueryInspector is null
UNSUPPORTED processQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.