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

Interface	osid.billing.payment.PayerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.billing.payment.PayerSearchSession`
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`. 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	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.billing.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchPayers
Description	Tests if this user can perform `Payer` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedBusinessView
Description	Federates the view for methods in this session. A federated view will include payers in business which are children of this business in the business hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBusinessView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this business only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPayerQuery
Description	Gets a payer query.
Return	`osid.billing.payment.PayerQuery`		the payer query
Compliance	`mandatory`		This method must be implemented.
Method	getPayersByQuery
Description	Gets a list of `Payers` matching the given payer query.
Parameters	`osid.billing.payment.PayerQuery`	`payerQuery`	the payer query
Return	`osid.billing.payment.PayerList`		the returned `PayerList`
Errors	NULL_ARGUMENT		`payerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`payerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.