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

This session manages queries and sequencing to create "smart" dynamic office. a StepConstrainerQuery can be retrieved from this session and mapped to this Office to create a virtual collection of step constrainers. The step constrainer may be sequenced using the StepConstrainerSearchOrder from this session.

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

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

Gets a step constrainer query.

Returnosid.workflow.rules.StepConstrainerQuerythe step constrainer query
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerSearchOrder
Description

Gets a step constrainer search order.

Returnosid.workflow.rules.StepConstrainerSearchOrderthe step constrainer search order
CompliancemandatoryThis method must be implemented.
MethodapplyStepConstrainerQuery
Description

Applies a step constrainer query to this office.

Parametersosid.workflow.rules.StepConstrainerQuerystepConstrainerQuerythe step constrainer query
ErrorsNULL_ARGUMENT stepConstrainerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED stepConstrainerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectStepConstrainerQuery
Description

Gets a step constrainer query inspector for this office.

Returnosid.workflow.rules.StepConstrainerQueryInspectorthe step constrainer query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyStepConstrainerSequencing
Description

Applies a step constrainer search order to this office.

Parametersosid.workflow.rules.StepConstrainerSearchOrderstepConstrainerSearchOrderthe step constrainer search order
ErrorsNULL_ARGUMENT stepConstrainerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED stepConstrainerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerQueryFromInspector
Description

Gets a step constrainer query from an inspector.

Parametersosid.workflow.rules.StepConstrainerQueryInspectorstepConstrainerQueryInspectora step constrainer query inspector
Returnosid.workflow.rules.StepConstrainerQuerythe step constrainer query
ErrorsNULL_ARGUMENT stepConstrainerQueryInspector is null
UNSUPPORTED stepConstrainerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.