OSID Logo
OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.BudgetEntryForm
Implementsosid.OsidRelationshipForm
Description

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.

MethodgetAmountMetadata
Description

Gets the metadata for the amount.

Returnosid.Metadatametadata for the amount
CompliancemandatoryThis method must be implemented.
MethodsetAmount
Description

Sets the amount.

Parametersosid.financials.Currencyamountthe new amount
ErrorsINVALID_ARGUMENT amount is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT amount is null
CompliancemandatoryThis method must be implemented.
MethodclearAmount
Description

Removes the amount.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDebitMetadata
Description

Gets the metadata for the debit flag.

Returnosid.Metadatametadata for the debit flag
CompliancemandatoryThis method must be implemented.
MethodsetDebit
Description

Sets the debit flag.

Parametersbooleandebit true if this budget entry is a debit, false if a credit
ErrorsINVALID_ARGUMENT debit is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearDebit
Description

Clears the debit flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntryFormRecord
Description

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

Parametersosid.type.TypebudgetEntryRecordTypea budget entry record type
Returnosid.financials.budgeting.records.BudgetEntryFormRecordthe budget entry form record
ErrorsNULL_ARGUMENT budgetEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(budgetEntryRecordType) is false
CompliancemandatoryThis method must be implemented.