org.osid.financials.budgeting

Interface BudgetForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

public interface BudgetForm
extends OsidRelationshipForm

This is the form for creating and updating Budgets. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BudgetAdminSession. 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
BudgetFormRecord	getBudgetFormRecord(Type budgetRecordType) Gets the BudgetFormRecord corresponding to the given budget 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.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getBudgetFormRecord

BudgetFormRecord getBudgetFormRecord(Type budgetRecordType)
                                     throws OperationFailedException

Gets the BudgetFormRecord corresponding to the given budget record Type.

Parameters:

budgetRecordType - a budget record type

Returns:

the budget form record

Throws:

NullArgumentException - budgetRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetRecordType) is false

Compliance:

mandatory - This method must be implemented.