OSID - osid.billing.CategorySearchSession Service Interface Definition

Interface	osid.billing.CategorySearchSession
Implements	`osid.billing.CategoryQuerySession`
Description	This session provides methods for searching among `Category` objects. The search query is constructed using the `CategoryQuery.` `getCategoriesByQuery()` is the basic search method and returns a list of `Categories.` A more advanced search may be performed with `getCategoriesBySearch().` It accepts a `CategorySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCategoriesBySearch()` returns a `CategorySearchResults` that can be used to access the resulting `CategoryList` or be used to perform a search within the result set through `CategorySearch.` This session defines views that offer differing behaviors for searching. federated business view: searches include categories in businesses of which this business is an ancestor in the business hierarchy isolated business view: searches are restricted to categories in this business Categories may have a query record indicated by their respective record types. The queryrecord is accessed via the `CategoryQuery.`
Method	getCategorySearch
Description	Gets a category search.
Return	`osid.billing.CategorySearch`		the category search
Compliance	`mandatory`		This method must be implemented.
Method	getCategorySearchOrder
Description	Gets a category search order. The `CategorySearchOrder` is supplied to a `CategorySearch` to specify the ordering of results.
Return	`osid.billing.CategorySearchOrder`		the category search order
Compliance	`mandatory`		This method must be implemented.
Method	getCategoriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.billing.CategoryQuery`	`categoryQuery`	the category query
Parameters	`osid.billing.CategorySearch`	`categorySearch`	the category search
Return	`osid.billing.CategorySearchResults`		the category search results
Errors	NULL_ARGUMENT		`categoryQuery` or `categorySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`categoryQuery` or `categorySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCategoryQueryFromInspector
Description	Gets a category query from an inspector. The inspector is available from a `CategorySearchResults.`
Parameters	`osid.assessment.ItemQueryInspector`	`categoryQueryInspector`	a category query inspector
Return	`osid.billing.CategoryQuery`		the category query
Errors	NULL_ARGUMENT		`categoryQueryInspector` is `null`
Errors	UNSUPPORTED		`categoryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.