OSID - osid.resourcing.EffortSearchSession Service Interface Definition

Interface	osid.resourcing.EffortSearchSession
Implements	`osid.resourcing.EffortQuerySession`
Used By	`osid.resourcing.ResourcingManager`
Used By	`osid.resourcing.ResourcingProxyManager`
Description	This session provides methods for searching among `Effort` objects. The search query is constructed using the `EffortQuery` . `getEffortsByQuery()` is the basic search method and returns a list of `Efforts` . A more advanced search may be performed with `getEffortsBySearch()` .It accepts an `EffortSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getEffortsBySearch()` returns an `EffortSearchResults` that can be used to access the resulting `EffortList` or be used to perform a search within the result set through `EffortSearch` . This session defines views that offer differing behaviors for searching. federated foundry view: searches include efforts in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to efforts in this foundry Efforts may have a query record indicated by their respective record types. The query record is accessed via the `EffortQuery` .
Method	getEffortSearch
Description	Gets an effort search.
Return	`osid.resourcing.EffortSearch`		the effort search
Compliance	`mandatory`		This method must be implemented.
Method	getEffortSearchOrder
Description	Gets an effort search order. The `EffortSearchOrder` is supplied to an `EffortSearch` to specify the ordering of results.
Return	`osid.resourcing.EffortSearchOrder`		the effort search order
Compliance	`mandatory`		This method must be implemented.
Method	getEffortsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resourcing.EffortQuery`	`effortQuery`	the effort query
Parameters	`osid.resourcing.EffortSearch`	`effortSearch`	the effort search
Return	`osid.resourcing.EffortSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`effortQuery` or `effortSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`effortQuery` or `effortSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEffortQueryFromInspector
Description	Gets an effort query from an inspector. The inspector is available from an `EffortSearchResults` .
Parameters	`osid.resourcing.EffortQueryInspector`	`effortQueryInspector`	an effort query inspector
Return	`osid.resourcing.EffortQuery`		the effort query
Errors	NULL_ARGUMENT		`effortQueryInspector` is `null`
Errors	UNSUPPORTED		`effortQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.