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

This session manages queries and sequencing to create "smart" dynamic catalogs. A StepQuery can be retrieved from this session and mapped to this Office to create a virtual collection of Steps. The step may be sequenced using the StepSearchOrder from this session.

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

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

Gets a step query.

Returnosid.workflow.StepQuerythe step query
CompliancemandatoryThis method must be implemented.
MethodgetStepSearchOrder
Description

Gets a step search order.

Returnosid.workflow.StepSearchOrderthe step search order
CompliancemandatoryThis method must be implemented.
MethodapplyStepQuery
Description

Applies a step query to this office.

Parametersosid.workflow.StepQuerystepQuerythe step query
ErrorsNULL_ARGUMENT stepQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED stepQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectStepQuery
Description

Gets a step query inspector for this office.

Returnosid.workflow.StepQueryInspectorthe step query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyStepSequencing
Description

Applies a step search order to this office.

Parametersosid.workflow.StepSearchOrderstepSearchOrderthe step search order
ErrorsNULL_ARGUMENT stepSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED stepSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepQueryFromInspector
Description

Gets a step query from an inspector.

Parametersosid.workflow.StepQueryInspectorstepQueryInspectora step query inspector
Returnosid.workflow.StepQuerythe step query
ErrorsNULL_ARGUMENT stepQueryInspector is null
UNSUPPORTED stepQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.