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

Interface	osid.workflow.rules.StepProcessorQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `StepProcessor` objects. The search query is constructed using the `StepProcessorQuery.` This session defines views that offer differing behaviors for searching. federated office view: searches include step processor in office of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to step processor in this office Step processor may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchStepProcessors
Description	Tests if this user can perform `StepProcessor` lookups. 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 processor in offices which are children of this step 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 lookups to this office only.
Compliance	`mandatory`		This method is 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	getStepProcessorsByQuery
Description	Gets a list of `StepProcessors` matching the given step processor query.
Parameters	`osid.workflow.rules.StepProcessorQuery`	`stepProcessorQuery`	the step processor query
Return	`osid.workflow.rules.StepProcessorList`		the returned `StepProcessorList`
Errors	NULL_ARGUMENT		`stepProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepProcessorQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.