OSID - osid.process.StateQuerySession Service Interface Definition

Interface	osid.process.StateQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `State` objects. The search query is constructed using the `StateQuery.` This session defines views that offer differing behaviors for searching. federated process view: searches include states in processes of which this process is a ancestor in the process hierarchy isolated process view: searches are restricted to states in this process States may have a query record indicated by their respective types. The queryrecord is accessed via the `StateQuery.`
Method	getProcessId
Description	Gets the `Process` `Id` associated with this session.
Return	`osid.id.Id`		the `Process Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getProcess
Description	Gets the `Process` associated with this session.
Return	`osid.process.Process`		the `Process` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchStates
Description	Tests if this user can perform `State` 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 opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedProcessView
Description	Federates the view for methods in this session. A federated view will include states in processes which are children of this process in the process hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedProcessView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this process only.
Compliance	`mandatory`		This method is must be implemented.
Method	getStateQuery
Description	Gets a state query.
Return	`osid.process.StateQuery`		the state query
Compliance	`mandatory`		This method must be implemented.
Method	getStatesByQuery
Description	Gets a list of `States` matching the given state query.
Parameters	`osid.process.StateQuery`	`stateQuery`	the state query
Return	`osid.process.StateList`		the returned `StateList`
Errors	NULL_ARGUMENT		`stateQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stateQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.