OSID - osid.billing.payment.PayerSearchSession Service Interface Definition

Interface	osid.billing.payment.PayerSearchSession
Implements	`osid.billing.payment.PayerQuerySession`
Used By	`osid.billing.payment.BillingPaymentManager`
Used By	`osid.billing.payment.BillingPaymentProxyManager`
Description	This session provides methods for searching among `Payers` . The search query is constructed using the `PayerQuery` . `getPayersByQuery()` is the basic search method and returns a list of `Payers` . A more advanced search may be performed with `getPayersBySearch()` . It accepts a `PayerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPayersBySearch()` returns a `PayerSearchResults` that can be used to access the resulting `PayerList` or be used to perform a search within the result set through `PayerSearch` . This session defines views that offer differing behaviors for searching. federated business view: searches include payers in businesses of which this business is an ancestor in the business hierarchy isolated business view: searches are restricted to payers in this business Payers may have a query record indicated by their respective record types. The query record is accessed via the `PayerQuery` .
Method	getPayerSearch
Description	Gets a payer search.
Return	`osid.billing.payment.PayerSearch`		the payer search
Compliance	`mandatory`		This method must be implemented.
Method	getPayerSearchOrder
Description	Gets a payer search order. The `PayerSearchOrder` is supplied to a `PayerSearch` to specify the ordering of results.
Return	`osid.billing.payment.PayerSearchOrder`		the payer search order
Compliance	`mandatory`		This method must be implemented.
Method	getPayersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.billing.payment.PayerQuery`	`payerQuery`	the payer query
Parameters	`osid.billing.payment.PayerSearch`	`payerSearch`	the payer search
Return	`osid.billing.payment.PayerSearchResults`		the payer search results
Errors	NULL_ARGUMENT		`payerQuery` or `payerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`payerQuery` or `payerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPayerQueryFromInspector
Description	Gets a payer query from an inspector. The inspector is available from a `PayerSearchResults` .
Parameters	`osid.billing.payment.PayerQueryInspector`	`payerQueryInspector`	a payer query inspector
Return	`osid.billing.payment.PayerQuery`		the payer query
Errors	NULL_ARGUMENT		`payerQueryInspector` is `null`
Errors	UNSUPPORTED		`payerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.