OSID - osid.resourcing.FoundrySearchSession Service Interface Definition

Interface	osid.resourcing.FoundrySearchSession
Implements	`osid.resourcing.FoundryQuerySession`
Description	This session provides methods for searching among `Foundry` objects. The search query is constructed using the `FoundryQuery.` `getFoundriesByQuery()` is the basic search method and returns a list of `Foundries.` A more advanced search may be performed with `getFoundriesBySearch().` It accepts a `FoundrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getFoundriesBySearch()` returns a `FoundrySearchResults` that can be used to access the resulting `FoundryList` or be used to perform a search within the result set through `FoundrySearch.` Foundries may have a query record indicated by their respective record types. The query record is accessed via the `FoundryQuery.`
Method	getFoundrySearch
Description	Gets a foundry search.
Return	`osid.resourcing.FoundrySearch`		the foundry search
Compliance	`mandatory`		This method must be implemented.
Method	getFoundrySearchOrder
Description	Gets a foundry search order. The `FoundrySearchOrder` is supplied to a `FoundrySearch` to specify the ordering of results.
Return	`osid.resourcing.FoundrySearchOrder`		the foundry search order
Compliance	`mandatory`		This method must be implemented.
Method	getFoundriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resourcing.FoundryQuery`	`foundryQuery`	the foundry query
Parameters	`osid.resourcing.FoundrySearch`	`foundrySearch`	the foundry search
Return	`osid.resourcing.FoundrySearchResults`		the returned search results
Errors	NULL_ARGUMENT		`foundryQuery` or `foundrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`foundryQuery` or `foundrySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFoundryQueryFromInspector
Description	Gets a foundry query from an inspector. The inspector is available from a `FoundrySearchResults.`
Parameters	`osid.resourcing.FoundryQueryInspector`	`foundryQueryInspector`	a foundry query inspector
Return	`osid.resourcing.FoundryQuery`		the foundry query
Errors	NULL_ARGUMENT		`foundryQueryInspector` is `null`
Errors	UNSUPPORTED		`foundryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.