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

Interface	osid.workflow.rules.StepConstrainerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.workflow.rules.StepConstrainerSearchSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `StepConstrainer` objects. The search query is constructed using the `StepConstrainerQuery`. This session defines views that offer differing behaviors for searching. federated office view: searches include step constrainer in office of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to step constrainer in this office Step constrainer may have a query record indicated by their respective record types. The query record is accessed via the `StepConstrainerQuery`.
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	canSearchStepConstrainers
Description	Tests if this user can perform `StepConstrainer` 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 constrainer 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	getStepConstrainerQuery
Description	Gets a step constrainer query.
Return	`osid.workflow.rules.StepConstrainerQuery`		the step constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainersByQuery
Description	Gets a list of `StepConstrainers` matching the given step constrainer query.
Parameters	`osid.workflow.rules.StepConstrainerQuery`	`stepConstrainerQuery`	the step constrainer query
Return	`osid.workflow.rules.StepConstrainerList`		the returned `StepConstrainerList`
Errors	NULL_ARGUMENT		`stepConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepConstrainerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.