Interface | osid.acknowledgement.CreditSmartBillingSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getBillingId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Billing Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBilling | ||
Description |
Gets the | ||
Return | osid.acknowledgement.Billing | the Billing associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
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 | ||
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 | |
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 | |
UNSUPPORTED | creditQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |