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

Interface	osid.billing.payment.PaymentSmartBusinessSession
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 `PaymentQuery` can be retrieved from this session and mapped to this `CoursOfferingeCatalog` to create a virtual collection of `Payments` . The payments may be sequenced using the `PaymentSearchOrder` from this session. This `Business` has a default query that matches any payment and a default search order that specifies no sequencing. The queries may be examined using a `PaymentQueryInspector` . The query may be modified by converting the inspector back to a `PaymentQuery` .
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	getPaymentQuery
Description	Gets a payment query.
Return	`osid.billing.payment.PaymentQuery`		the payment query
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentSearchOrder
Description	Gets a payment search order.
Return	`osid.billing.payment.PaymentSearchOrder`		the payment search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPaymentQuery
Description	Applies a payment query to this business.
Parameters	`osid.billing.payment.PaymentQuery`	`paymentQuery`	the payment query
Errors	NULL_ARGUMENT		`paymentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`paymentQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPaymentQuery
Description	Gets a payment query inspector for this business.
Return	`osid.billing.payment.PaymentQueryInspector`		the payment query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPaymentSequencing
Description	Applies a payment search order to this business.
Parameters	`osid.billing.payment.PaymentSearchOrder`	`paymentSearchOrder`	the payment search order
Errors	NULL_ARGUMENT		`paymentSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`paymentSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentQueryFromInspector
Description	Gets a payment query from an inspector.
Parameters	`osid.billing.payment.PaymentQueryInspector`	`paymentQueryInspector`	a 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.