OSID - osid.workflow.rules.StepConstrainerEnablerSmartOfficeSession Service Interface Definition

Interface	osid.workflow.rules.StepConstrainerEnablerSmartOfficeSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
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`.
Method	getOfficeId
Description	Gets the `Office` `Id` associated with this session.
Return	`osid.id.Id`		the `Office Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOffice
Description	Gets the `Office` associated with this session.
Return	`osid.workflow.Office`		the office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartOffices
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.
Return	`boolean`		`false` if smart office management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainerEnablerQuery
Description	Gets a step constrainer enabler query.
Return	`osid.workflow.rules.StepConstrainerEnablerQuery`		the step constrainer enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainerEnablerSearchOrder
Description	Gets a step constrainer enabler search order.
Return	`osid.workflow.rules.StepConstrainerEnablerSearchOrder`		the step constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyStepConstrainerEnablerQuery
Description	Applies a step constrainer enabler query to this office.
Parameters	`osid.workflow.rules.StepConstrainerEnablerQuery`	`stepConstrainerEnablerQuery`	the step constrainer enabler query
Errors	NULL_ARGUMENT		`stepConstrainerEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`stepConstrainerEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectStepConstrainerEnablerQuery
Description	Gets a step constrainer enabler query inspector for this office.
Return	`osid.workflow.rules.StepConstrainerEnablerQueryInspector`		the step constrainer enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyStepConstrainerEnablerSequencing
Description	Applies a step constrainer enabler search order to this office.
Parameters	`osid.workflow.rules.StepConstrainerEnablerSearchOrder`	`stepConstrainerEnablerSearchOrder`	the step constrainer enabler search order
Errors	NULL_ARGUMENT		`stepConstrainerEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`stepConstrainerEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainerEnablerQueryFromInspector
Description	Gets a step constrainer enabler query from an inspector.
Parameters	`osid.workflow.rules.StepConstrainerEnablerQueryInspector`	`stepConstrainerEnablerQueryInspector`	a step constrainer enabler query inspector
Return	`osid.workflow.rules.StepConstrainerEnablerQuery`		the step constrainer enabler query
Errors	NULL_ARGUMENT		`stepConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`stepConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.