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.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getAmountMetadata()
mandatory
- This method must be implemented. void setAmount(Currency amount)
amount
- the new amountInvalidArgumentException
- amount
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- amount
is
null
mandatory
- This method must be implemented. void clearAmount()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDebitMetadata()
mandatory
- This method must be implemented. void setDebit(boolean debit)
debit
- true
if this budget entry is a debit,
false
if a creditInvalidArgumentException
- debit
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearDebit()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. BudgetEntryFormRecord getBudgetEntryFormRecord(Type budgetEntryRecordType) throws OperationFailedException
BudgetEntryFormRecord
corresponding to the
given budget entry record Type.
budgetEntryRecordType
- a budget entry record typeNullArgumentException
- budgetEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(budgetEntryRecordType)
is false
mandatory
- This method must be implemented.