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

Interface	osid.billing.payment.PaymentSearchSession
Implements	`osid.billing.payment.PaymentQuerySession`
Description	This session provides methods for searching among `Payment` objects. The search query is constructed using the `PaymentQuery.` `getPaymentsByQuery()` is the basic search method and returns a list of `Payments.` A more advanced search may be performed with `getPaymentsBySearch().` It accepts a `PaymentSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPaymentsBySearch()` returns a `PaymentSearchResults` that can be used to access the resulting `PaymentList` or be used to perform a search within the result set through `PaymentSearch.` This session defines views that offer differing behaviors for searching. federated business view: searches include payments in businesses of which this business is an ancestor in the business hierarchy isolated business view: searches are restricted to payments in this business Payments may have a query record indicated by their respective record types. The queryrecord is accessed via the `PaymentQuery.`
Method	getPaymentSearch
Description	Gets a payment search.
Return	`osid.billing.payment.PaymentSearch`		the payment search
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentSearchOrder
Description	Gets a payment search order. The `PaymentSearchOrder` is supplied to a `PaymentSearch` to specify the ordering of results.
Return	`osid.billing.payment.PaymentSearchOrder`		the payment search order
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.billing.payment.PaymentQuery`	`paymentQuery`	the payment query
Parameters	`osid.billing.payment.PaymentSearch`	`paymentSearch`	the payment search
Return	`osid.billing.payment.PaymentSearchResults`		the payment search results
Errors	NULL_ARGUMENT		`paymentQuery` or `paymentSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`paymentQuery` or `paymentSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentQueryFromInspector
Description	Gets a payment query from an inspector. The inspector is available from a `PaymentSearchResults.`
Parameters	`osid.assessment.ItemQueryInspector`	`paymentQueryInspector`	a payment query inspector
Return	`osid.billing.payment.PaymentQuery`		the payment query
Errors	NULL_ARGUMENT		`paymentQueryInspector` is `null`
Errors	UNSUPPORTED		`paymentQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.