OSID - osid.acknowledgement.CreditSmartBillingSession Service Interface Definition

Interface	osid.acknowledgement.CreditSmartBillingSession
Implements	`osid.OsidSession`
Used By	`osid.acknowledgement.AcknowledgementManager`
Used By	`osid.acknowledgement.AcknowledgementProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CreditQuery` can be retrieved from this session and mapped to this `Billing` to create a virtual collection of `Credits`. The credits may be sequenced using the `CreditSearchOrder` from this session. This `Billing` has a default query that matches any credit and a default search order that specifies no sequencing. The queries may be examined using a `CreditQueryInspector`. The query may be modified by converting the inspector back to a `CreditQuery` .
Method	getBillingId
Description	Gets the `Billing` `Id` associated with this session.
Return	`osid.id.Id`		the `Billing Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBilling
Description	Gets the `Billing` associated with this session.
Return	`osid.acknowledgement.Billing`		the `Billing` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartBillings
Description	Tests if this user can manage smart billings. A return of true does not guarantee successful authorization. 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 billing management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCreditQuery
Description	Gets a credit query.
Return	`osid.acknowledgement.CreditQuery`		the credit query
Compliance	`mandatory`		This method must be implemented.
Method	getCreditSearchOrder
Description	Gets a credit search order.
Return	`osid.acknowledgement.CreditSearchOrder`		the credit search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCreditQuery
Description	Applies a credit query to this billing.
Parameters	`osid.acknowledgement.CreditQuery`	`creditQuery`	the credit query
Errors	NULL_ARGUMENT		`creditQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`creditQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCreditQuery
Description	Gets a credit query inspector for this billing.
Return	`osid.acknowledgement.CreditQueryInspector`		the credit query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCreditSequencing
Description	Applies a credit search order to this billing.
Parameters	`osid.acknowledgement.CreditSearchOrder`	`creditSearchOrder`	the credit search order
Errors	NULL_ARGUMENT		`creditSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`creditSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCreditQueryFromInspector
Description	Gets a credit query from an inspector.
Parameters	`osid.acknowledgement.CreditQueryInspector`	`creditQueryInspector`	a query inspector
Return	`osid.acknowledgement.CreditQuery`		the credit query
Errors	NULL_ARGUMENT		`creditQueryInspector` is `null`
Errors	UNSUPPORTED		`creditQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.