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

This session manages queries and sequencing to create "smart" dynamic office. a StepProcessorEnablerQuery can be retrieved from this session and mapped to this Office to create a virtual collection of step processor enablers. The step processor enablers may be sequenced using the StepProcessorEnablerSearchOrder from this session.

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

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 office. 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.
MethodgetStepProcessorEnablerQuery
Description

Gets a step processor enabler query.

Returnosid.workflow.rules.StepProcessorEnablerQuerythe step processor enabler query
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorEnablerSearchOrder
Description

Gets a step processor enabler search order.

Returnosid.workflow.rules.StepProcessorEnablerSearchOrderthe step processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyStepProcessorEnablerQuery
Description

Applies a step processor enabler query to this office.

Parametersosid.workflow.rules.StepProcessorEnablerQuerystepProcessorEnablerQuerythe step processor enabler query
ErrorsNULL_ARGUMENT stepProcessorEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED stepProcessorEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectStepProcessorEnablerQuery
Description

Gets a step processor enabler query inspector for this office.

Returnosid.workflow.rules.StepProcessorEnablerQueryInspectorthe step processor enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyStepProcessorEnablerSequencing
Description

Applies a step processor enabler search order to this office.

Parametersosid.workflow.rules.StepProcessorEnablerSearchOrderstepProcessorEnablerSearchOrderthe step processor enabler search order
ErrorsNULL_ARGUMENT stepProcessorEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED stepProcessorEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorEnablerQueryFromInspector
Description

Gets a step processor enabler query from an inspector.

Parametersosid.workflow.rules.StepProcessorEnablerQueryInspectorstepProcessorEnablerQueryInspectora step processor enabler query inspector
Returnosid.workflow.rules.StepProcessorEnablerQuerythe step processor enabler query
ErrorsNULL_ARGUMENT stepProcessorEnablerQueryInspector is null
UNSUPPORTED stepProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.