OSID - osid.financials.BusinessSearchSession Service Interface Definition

Interface	osid.financials.BusinessSearchSession
Implements	`osid.financials.BusinessQuerySession`
Description	This session provides methods for searching among `Business` objects. The search query is constructed using the `BusinessQuery.` `getBusinessesByQuery()` is the basic search method and returns a list of `Businesses.` A more advanced search may be performed with `getBusinessesBySearch().` It accepts a `BusinessSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBusinessesBySearch()` returns a `BusinessSearchResults` that can be used to access the resulting `BusinessList` or be used to perform a search within the result set through `Businessesearch.` This session defines views that offer differing behaviors for searching. federated business view: searches include businesses in businesses of which this business is an ancestor in the business hierarchy isolated business view: searches are restricted to businesses in this business businesses may have a query record indicated by their respective record types. The query record is accessed via the `BusinessQuery.`
Method	getBusinessSearch
Description	Gets a business search.
Return	`osid.financials.BusinessSearch`		the business search
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessSearchOrder
Description	Gets a business search order. The `BusinessSearchOrder` is supplied to a `BusinessSearch` to specify the ordering of results.
Return	`osid.financials.BusinessSearchOrder`		the business search order
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.financials.BusinessQuery`	`businessQuery`	the business query
Parameters	`osid.financials.BusinessSearch`	`businessSearch`	the business search
Return	`osid.financials.BusinessSearchResults`		the business search results
Errors	NULL_ARGUMENT		`businessQuery` or `businessSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`businessQuery` or `businessSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessQueryFromInspector
Description	Gets a business query from an inspector. The inspector is available from a `BusinessSearchResults.`
Parameters	`osid.financials.BusinessQueryInspector`	`businessQueryInspector`	a business query inspector
Return	`osid.financials.BusinessQuery`		the business query
Errors	NULL_ARGUMENT		`businessQueryInspector` is `null`
Errors	UNSUPPORTED		`businessQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.