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

Interface	osid.billing.payment.PayerSmartBusinessSession
Implements	`osid.OsidSession`
Used By	`osid.billing.payment.BillingPaymentManager`
Used By	`osid.billing.payment.BillingPaymentProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `PayerQuery` can be retrieved from this session and mapped to this `Business` to create a virtual collection of `Payers`. The payers may be sequenced using the `PayerSearchOrder` from this session. This `Business` has a default query that matches any payer and a default search order that specifies no sequencing. The queries may be examined using a `PayerQueryInspector`. The query may be modified by converting the inspector back to a `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	canManageSmartBusinesses
Description	Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart business management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getPayerSearchOrder
Description	Gets a payer search order.
Return	`osid.billing.payment.PayerSearchOrder`		the payer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPayerQuery
Description	Applies a payer query to this business.
Parameters	`osid.billing.payment.PayerQuery`	`payerQuery`	the payer query
Errors	NULL_ARGUMENT		`payerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`payerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPayerQuery
Description	Gets a payer query inspector for this business.
Return	`osid.billing.payment.PayerQueryInspector`		the payer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPayerSequencing
Description	Applies a payer search order to this business.
Parameters	`osid.billing.payment.PayerSearchOrder`	`payerSearchOrder`	the payer search order
Errors	NULL_ARGUMENT		`payerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`payerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPayerQueryFromInspector
Description	Gets a payer query from an inspector.
Parameters	`osid.billing.payment.PayerQueryInspector`	`payerQueryInspector`	a 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.