Interface | osid.financials.budgeting.BudgetEntryForm | ||
---|---|---|---|
Implements | osid.OsidRelationshipForm | ||
Description |
This is the form for creating and updating | ||
Method | getAmountMetadata | ||
Description |
Gets the metadata for the amount. | ||
Return | osid.Metadata | metadata for the amount | |
Compliance | mandatory | This method must be implemented. | |
Method | setAmount | ||
Description |
Sets the amount. | ||
Parameters | osid.financials.Currency | amount | the new amount |
Errors | INVALID_ARGUMENT | amount is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | amount is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearAmount | ||
Description |
Removes the amount. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getDebitMetadata | ||
Description |
Gets the metadata for the debit flag. | ||
Return | osid.Metadata | metadata for the debit flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setDebit | ||
Description |
Sets the debit flag. | ||
Parameters | boolean | debit | true if this budget entry is a debit, false
if a credit |
Errors | INVALID_ARGUMENT | debit is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDebit | ||
Description |
Clears the debit flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntryFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | budgetEntryRecordType | a budget entry record type |
Return | osid.financials.budgeting.records.BudgetEntryFormRecord | the budget entry form record | |
Errors | NULL_ARGUMENT | budgetEntryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(budgetEntryRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |