org.osid.acknowledgement

Interface BillingForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

BillingBatchForm

public interface BillingForm
extends OsidCatalogForm

This is the form for creating and updating Billings. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BillingAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
BillingFormRecord	getBillingFormRecord(Type billingRecordType) Gets the BillingFormRecord interface corresponding to the given billing record Type.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getBillingFormRecord

BillingFormRecord getBillingFormRecord(Type billingRecordType)
                                       throws OperationFailedException

Gets the BillingFormRecord interface corresponding to the given billing record Type.

Parameters:

billingRecordType - the billing record type

Returns:

the record

Throws:

NullArgumentException - billingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(billingRecordType) is false

Compliance:

mandatory - This method must be implemented.