OSID - osid.workflow.WorkSearchSession Service Interface Definition

Interface	osid.workflow.WorkSearchSession
Implements	`osid.workflow.WorkQuerySession`
Used By	`osid.workflow.WorkflowManager`
Used By	`osid.workflow.WorkflowProxyManager`
Description	This session provides methods for searching among `Works` . The search query is constructed using the `WorkQuery` . `getWorksByQuery()` is the basic search method and returns a list of `Works` . A more advanced search may be performed with `getWorksBySearch()` . It accepts a `WorkSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getWorksBySearch()` returns a `WorkSearchResults` that can be used to access the resulting `WorkList` or be used to perform a search within the result set through `WorkSearch` . This session defines views that offer differing behaviors for searching. federated office view: searches include works in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to works in this office Works may have a query record indicated by their respective record types. The query record is accessed via the `WorkQuery` .
Method	getWorkSearch
Description	Gets a work search.
Return	`osid.workflow.WorkSearch`		the work search
Compliance	`mandatory`		This method must be implemented.
Method	getWorkSearchOrder
Description	Gets a work search order. The `WorkSearchOrder` is supplied to a `WorkSearch` to specify the ordering of results.
Return	`osid.workflow.WorkSearchOrder`		the work search order
Compliance	`mandatory`		This method must be implemented.
Method	getWorksBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.WorkQuery`	`workQuery`	the work query
Parameters	`osid.workflow.WorkSearch`	`workSearch`	the work search
Return	`osid.workflow.WorkSearchResults`		the work search results
Errors	NULL_ARGUMENT		`workQuery` or `workSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`workQuery` or `workSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getWorkQueryFromInspector
Description	Gets a work query from an inspector. The inspector is available from a `WorkSearchResults` .
Parameters	`osid.workflow.WorkQueryInspector`	`workQueryInspector`	a work query inspector
Return	`osid.workflow.WorkQuery`		the work query
Errors	NULL_ARGUMENT		`workQueryInspector` is `null`
Errors	UNSUPPORTED		`workQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.