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

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

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

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

Gets a step processor query.

Returnosid.workflow.rules.StepProcessorQuerythe step processor query
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorSearchOrder
Description

Gets a step processor search order.

Returnosid.workflow.rules.StepProcessorSearchOrderthe step processor search order
CompliancemandatoryThis method must be implemented.
MethodapplyStepProcessorQuery
Description

Applies a step processor query to this office.

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

Gets a step processor query inspector for this office.

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

Applies a step processor search order to this office.

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

Gets a step processor query from an inspector.

Parametersosid.workflow.rules.StepProcessorQueryInspectorstepProcessorQueryInspectora step processor query inspector
Returnosid.workflow.rules.StepProcessorQuerythe step processor query
ErrorsNULL_ARGUMENT stepProcessorQueryInspector is null
UNSUPPORTED stepProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.