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

Interface	osid.workflow.rules.StepProcessorSmartOfficeSession
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 `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`.
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	getStepProcessorQuery
Description	Gets a step processor query.
Return	`osid.workflow.rules.StepProcessorQuery`		the step processor query
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorSearchOrder
Description	Gets a step processor search order.
Return	`osid.workflow.rules.StepProcessorSearchOrder`		the step processor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyStepProcessorQuery
Description	Applies a step processor query to this office.
Parameters	`osid.workflow.rules.StepProcessorQuery`	`stepProcessorQuery`	the step processor query
Errors	NULL_ARGUMENT		`stepProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`stepProcessorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectStepProcessorQuery
Description	Gets a step processor query inspector for this office.
Return	`osid.workflow.rules.StepProcessorQueryInspector`		the step processor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyStepProcessorSequencing
Description	Applies a step processor search order to this office.
Parameters	`osid.workflow.rules.StepProcessorSearchOrder`	`stepProcessorSearchOrder`	the step processor search order
Errors	NULL_ARGUMENT		`stepProcessorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`stepProcessorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorQueryFromInspector
Description	Gets a step processor query from an inspector.
Parameters	`osid.workflow.rules.StepProcessorQueryInspector`	`stepProcessorQueryInspector`	a step processor query inspector
Return	`osid.workflow.rules.StepProcessorQuery`		the step processor query
Errors	NULL_ARGUMENT		`stepProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`stepProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.