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

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

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

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

Gets a step constrainer enabler query.

Returnosid.workflow.rules.StepConstrainerEnablerQuerythe step constrainer enabler query
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablerSearchOrder
Description

Gets a step constrainer enabler search order.

Returnosid.workflow.rules.StepConstrainerEnablerSearchOrderthe step constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyStepConstrainerEnablerQuery
Description

Applies a step constrainer enabler query to this office.

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

Gets a step constrainer enabler query inspector for this office.

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

Applies a step constrainer enabler search order to this office.

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

Gets a step constrainer enabler query from an inspector.

Parametersosid.workflow.rules.StepConstrainerEnablerQueryInspectorstepConstrainerEnablerQueryInspectora step constrainer enabler query inspector
Returnosid.workflow.rules.StepConstrainerEnablerQuerythe step constrainer enabler query
ErrorsNULL_ARGUMENT stepConstrainerEnablerQueryInspector is null
UNSUPPORTED stepConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.