OSID - osid.billing.CustomerSearchSession Service Interface Definition

Interface	osid.billing.CustomerSearchSession
Implements	`osid.billing.CustomerQuerySession`
Description	This session provides methods for searching among `Customer` objects. The search query is constructed using the `CustomerQuery.` `getCustomersByQuery()` is the basic search method and returns a list of `Customers.` A more advanced search may be performed with `getCustomersBySearch().` It accepts a `CustomerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCustomersBySearch()` returns a `CustomerSearchResults` that can be used to access the resulting `CustomerList` or be used to perform a search within the result set through `CustomerSearch.` This session defines views that offer differing behaviors for searching. federated business view: searches include customers in businesses of which this business is an ancestor in the business hierarchy isolated business view: searches are restricted to customers in this business Customers may have a query record indicated by their respective record types. The query record is accessed via the `CustomerQuery.`
Method	getCustomerSearch
Description	Gets a customer search.
Return	`osid.billing.CustomerSearch`		the customer search
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerSearchOrder
Description	Gets a customer search order. The `CustomerSearchOrder` is supplied to a `CustomerSearch` to specify the ordering of results.
Return	`osid.billing.CustomerSearchOrder`		the customer search order
Compliance	`mandatory`		This method must be implemented.
Method	getCustomersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.billing.CustomerQuery`	`customerQuery`	the customer query
Parameters	`osid.billing.CustomerSearch`	`customerSearch`	the customer search
Return	`osid.billing.CustomerSearchResults`		the customer search results
Errors	NULL_ARGUMENT		`customerQuery` or `customerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`customerQuery` or `customerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerQueryFromInspector
Description	Gets a customer query from an inspector. The inspector is available from a `CustomerSearchResults.`
Parameters	`osid.billing.CustomerQueryInspector`	`customerQueryInspector`	a customer query inspector
Return	`osid.billing.CustomerQuery`		the customer query
Errors	NULL_ARGUMENT		`customerQueryInspector` is `null`
Errors	UNSUPPORTED		`customerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.