OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.CreditSmartBillingSession
Implementsosid.OsidSession
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.

MethodgetBillingId
Description

Gets the Billing Id associated with this session.

Returnosid.id.Idthe Billing Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBilling
Description

Gets the Billing associated with this session.

Returnosid.acknowledgement.Billingthe Billing associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartBillings
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.

Returnboolean false if smart billing management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCreditQuery
Description

Gets a credit query.

Returnosid.acknowledgement.CreditQuerythe credit query
CompliancemandatoryThis method must be implemented.
MethodgetCreditSearchOrder
Description

Gets a credit search order.

Returnosid.acknowledgement.CreditSearchOrderthe credit search order
CompliancemandatoryThis method must be implemented.
MethodapplyCreditQuery
Description

Applies a credit query to this billing.

Parametersosid.acknowledgement.CreditQuerycreditQuerythe credit query
ErrorsNULL_ARGUMENT creditQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED creditQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectCreditQuery
Description

Gets a credit query inspector for this billing.

Returnosid.acknowledgement.CreditQueryInspectorthe credit query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyCreditSequencing
Description

Applies a credit search order to this billing.

Parametersosid.acknowledgement.CreditSearchOrdercreditSearchOrderthe credit search order
ErrorsNULL_ARGUMENT creditSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED creditSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCreditQueryFromInspector
Description

Gets a credit query from an inspector.

Parametersosid.acknowledgement.CreditQueryInspectorcreditQueryInspectora query inspector
Returnosid.acknowledgement.CreditQuerythe credit query
ErrorsNULL_ARGUMENT creditQueryInspector is null
UNSUPPORTED creditQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.