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 OsidForms, 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 Details

    • 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.