org.osid.acknowledgement

Interface Billing

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Billing
extends OsidCatalog

A Billing represents a collection of credits. Like all OSID objects, a Billing is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
BillingRecord	getBillingRecord(Type billingRecordType) Gets the record corresponding to the given Billing record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getBillingRecord

BillingRecord getBillingRecord(Type billingRecordType)
                               throws OperationFailedException

Gets the record corresponding to the given Billing record Type. This method is used to retrieve an object implementing the requested record. The billingRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(billingRecordType) is true .

Parameters:

billingRecordType - the type of billing record to retrieve

Returns:

the billing record

Throws:

NullArgumentException - billingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(billingRecordType) is false

Compliance:

mandatory - This method must be implemented.