org.osid.financials

Interface BusinessForm

All Superinterfaces:

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

All Known Subinterfaces:

BudgetBatchForm, BudgetEntryBatchForm, BusinessBatchForm, PostBatchForm, PostEntryBatchForm

public interface BusinessForm
extends OsidCatalogForm

This is the form for creating and updating businesses. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BusinessAdminSession. 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
BusinessFormRecord	getBusinessFormRecord(Type businessRecordType) Gets the BusinessFormRecord corresponding to the given business 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

getBusinessFormRecord

BusinessFormRecord getBusinessFormRecord(Type businessRecordType)
                                         throws OperationFailedException

Gets the BusinessFormRecord corresponding to the given business record Type.

Parameters:

businessRecordType - a business record type

Returns:

the business form record

Throws:

NullArgumentException - businessRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(businessRecordType) is false

Compliance:

mandatory - This method must be implemented.