org.osid.financials.budgeting

Interface BudgetEntryForm

All Superinterfaces:

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

public interface BudgetEntryForm
extends OsidRelationshipForm

This is the form for creating and updating BudgetEntries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BudgetEntryAdminSession. 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
void	clearAmount() Removes the amount.
void	clearDebit() Clears the debit flag.
Metadata	getAmountMetadata() Gets the metadata for the amount.
BudgetEntryFormRecord	getBudgetEntryFormRecord(Type budgetEntryRecordType) Gets the BudgetEntryFormRecord corresponding to the given budget entry record Type.
Metadata	getDebitMetadata() Gets the metadata for the debit flag.
void	setAmount(Currency amount) Sets the amount.
void	setDebit(boolean debit) Sets the debit flag.

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

getAmountMetadata

Metadata getAmountMetadata()

Gets the metadata for the amount.

Returns:

metadata for the amount

Compliance:

mandatory - This method must be implemented.

setAmount

void setAmount(Currency amount)

Sets the amount.

Parameters:

amount - the new amount

Throws:

InvalidArgumentException - amount is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - amount is null

Compliance:

mandatory - This method must be implemented.

clearAmount

void clearAmount()

Removes the amount.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDebitMetadata

Metadata getDebitMetadata()

Gets the metadata for the debit flag.

Returns:

metadata for the debit flag

Compliance:

mandatory - This method must be implemented.

setDebit

void setDebit(boolean debit)

Sets the debit flag.

Parameters:

debit - true if this budget entry is a debit, false if a credit

Throws:

InvalidArgumentException - debit is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearDebit

void clearDebit()

Clears the debit flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getBudgetEntryFormRecord

BudgetEntryFormRecord getBudgetEntryFormRecord(Type budgetEntryRecordType)
                                               throws OperationFailedException

Gets the BudgetEntryFormRecord corresponding to the given budget entry record Type.

Parameters:

budgetEntryRecordType - a budget entry record type

Returns:

the budget entry form record

Throws:

NullArgumentException - budgetEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.