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

Interface	osid.workflow.rules.StepEnablerSmartOfficeSession
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 catalogs. A `StepEnablerQuery` can be retrieved from this session and mapped to this `Office` to create a virtual collection of `StepEnablers` . The step enablers may be sequenced using the `StepEnablerSearchOrder` from this session. This `Office` has a default query that matches any step enabler and a default search order that specifies no sequencing. The queries may be examined using a `StepEnablerQueryInspector` . The query may be modified by converting the inspector back to a `StepEnablerQuery` .
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 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.
Return	`boolean`		`false` if smart office management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStepEnablerQuery
Description	Gets a step enabler query.
Return	`osid.workflow.rules.StepEnablerQuery`		the step enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getStepEnablerSearchOrder
Description	Gets a step enabler search order.
Return	`osid.workflow.rules.StepEnablerSearchOrder`		the step enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyStepEnablerQuery
Description	Applies a step enabler query to this office.
Parameters	`osid.workflow.rules.StepEnablerQuery`	`stepEnablerQuery`	the step enabler query
Errors	NULL_ARGUMENT		`stepEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`stepEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectStepEnablerQuery
Description	Gets a step enabler query inspector for this office.
Return	`osid.workflow.rules.StepEnablerQueryInspector`		the step enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyStepEnablerSequencing
Description	Applies a step enabler search order to this office.
Parameters	`osid.workflow.rules.StepEnablerSearchOrder`	`stepEnablerSearchOrder`	the step enabler search order
Errors	NULL_ARGUMENT		`stepEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`stepEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStepEnablerQueryFromInspector
Description	Gets a step enabler query from an inspector.
Parameters	`osid.workflow.rules.StepEnablerQueryInspector`	`stepEnablerQueryInspector`	a step enabler query inspector
Return	`osid.workflow.StepQuery`		the step enabler query
Errors	NULL_ARGUMENT		`stepEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`stepEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.