OSID - osid.workflow.StepSearchSession Service Interface Definition

Interface	osid.workflow.StepSearchSession
Implements	`osid.workflow.StepQuerySession`
Description	This session provides methods for searching among `Step` objects. The search query is constructed using the `StepQuery.` `getStepsByQuery()` is the basic search method and returns a list of `Steps.` A more advanced search may be performed with `getStepsBySearch().` It accepts a `StepSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getStepsBySearch()` returns a `StepSearchResults` that can be used to access the resulting `StepList` or be used to perform a search within the result set through `StepSearch.` This session defines views that offer differing behaviors for searching. federated office view: searches include steps in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to steps in this office Steps may have a query record indicated by their respective record types. The query record is accessed via the `StepQuery.`
Method	getStepSearch
Description	Gets a step search.
Return	`osid.workflow.StepSearch`		the step search
Compliance	`mandatory`		This method must be implemented.
Method	getStepSearchOrder
Description	Gets a step search order. The `StepSearchOrder` is supplied to a `StepSearch` to specify the ordering of results.
Return	`osid.workflow.StepSearchOrder`		the step search order
Compliance	`mandatory`		This method must be implemented.
Method	getStepsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.StepQuery`	`stepQuery`	the step query
Parameters	`osid.workflow.StepSearch`	`stepSearch`	the step search
Return	`osid.workflow.StepSearchResults`		the step search results
Errors	NULL_ARGUMENT		`stepQuery` or `stepSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepQuery` or `stepSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStepQueryFromInspector
Description	Gets a step query from an inspector. The inspector is available from a `StepSearchResults.`
Parameters	`osid.workflow.StepQueryInspector`	`stepQueryInspector`	a step query inspector
Return	`osid.workflow.StepQuery`		the step query
Errors	NULL_ARGUMENT		`stepQueryInspector` is `null`
Errors	UNSUPPORTED		`stepQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.