OSID - osid.process.StateSearchSession Service Interface Definition

Interface	osid.process.StateSearchSession
Implements	`osid.process.StateQuerySession`
Used By	`osid.process.ProcessManager`
Used By	`osid.process.ProcessProxyManager`
Description	This session provides methods for searching among `State` objects. The search query is constructed using the `StateQuery` . `getStatesByQuery()` is the basic search method and returns a list of `States` . A more advanced search may be performed with `getStatesBySearch()` . It accepts an `StateSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getStatesBySearch()` returns an `StateSearchResults` that can be used to access the resulting `StateList` or be used to perform a search within the result set through `StateList` . 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 record types. The query record is accessed via the `StateQuery` .
Method	getStateSearch
Description	Gets a state search.
Return	`osid.process.StateSearch`		the state search
Compliance	`mandatory`		This method must be implemented.
Method	getStateSearchOrder
Description	Gets a state search order. The `StateSearchOrder` is supplied to a `StateSearch` to specify the ordering of results.
Return	`osid.process.StateSearchOrder`		the state search order
Compliance	`mandatory`		This method must be implemented.
Method	getStatesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.process.StateQuery`	`stateQuery`	the state query
Parameters	`osid.process.StateSearch`	`stateSearch`	the state search
Return	`osid.process.StateSearchResults`		the state search results
Errors	NULL_ARGUMENT		`stateQuery` or `stateSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stateQuery` or `stateSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStateQueryFromInspector
Description	Gets a state query from an inspector. The inspector is available from a `StateSearchResults` .
Parameters	`osid.process.StateQueryInspector`	`stateQueryInspector`	a state inspector
Return	`osid.process.StateQuery`		the state query
Errors	NULL_ARGUMENT		`stateQueryInspector` is `null`
Errors	UNSUPPORTED		`stateQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.