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

Interface	osid.workflow.rules.StepEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.workflow.rules.StepEnablerSearchSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `StepEnabler` objects. The search query is constructed using the `StepEnablerQuery` . This session defines views that offer differing behaviors for searching. federated office view: searches include step enablers in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to step enablers in this office Step enablers may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchStepEnablers
Description	Tests if this user can perform `StepEnabler` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedOfficeView
Description	Federates the view for methods in this session. A federated view will include step enablers in offices which are children of this office in the office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this office only.
Compliance	`mandatory`		This method is 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	getStepEnablersByQuery
Description	Gets a list of `StepEnablers` matching the given search.
Parameters	`osid.workflow.rules.StepEnablerQuery`	`stepEnablerQuery`	the step enabler query
Return	`osid.workflow.rules.StepEnablerList`		the returned `StepEnablerList`
Errors	NULL_ARGUMENT		`stepEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepEnablerQuery` did not originate from `getStepEnablerQuery()`
Compliance	`mandatory`		This method must be implemented.