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

This session manages queries and sequencing to create "smart" dynamic offices. A ProcessEnablerQuery can be retrieved from this session and mapped to this Office to create a virtual collection of process enablers. The process enabler may be sequenced using the ProcessEnablerSearchOrder from this session.

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

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

Gets a process enabler query.

Returnosid.workflow.rules.ProcessEnablerQuerythe process enabler query
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablerSearchOrder
Description

Gets a process enabler search order.

Returnosid.workflow.rules.ProcessEnablerSearchOrderthe process enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyProcessEnablerQuery
Description

Applies a process enabler query to this office.

Parametersosid.workflow.rules.ProcessEnablerQueryprocessEnablerQuerythe process enabler query
ErrorsNULL_ARGUMENT processEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED processEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectProcessEnablerQuery
Description

Gets a process enabler query inspector for this office.

Returnosid.workflow.rules.ProcessEnablerQueryInspectorthe process enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyProcessEnablerSequencing
Description

Applies a process enabler search order to this office.

Parametersosid.workflow.rules.ProcessEnablerSearchOrderprocessEnablerSearchOrderthe process enabler search order
ErrorsNULL_ARGUMENT processEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED processEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablerQueryFromInspector
Description

Gets a process enabler query from an inspector.

Parametersosid.workflow.rules.ProcessEnablerQueryInspectorprocessEnablerQueryInspectora process enabler query inspector
Returnosid.workflow.rules.ProcessEnablerQuerythe process enabler query
ErrorsNULL_ARGUMENT processEnablerQueryInspector is null
UNSUPPORTED processEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.