Package org.salespointframework.accountancy

Class AccountancyEntry

java.lang.Object
org.salespointframework.core.AbstractEntity<ID>
org.salespointframework.core.AbstractAggregateRoot<AccountancyEntry.AccountancyEntryIdentifier>
org.salespointframework.accountancy.AccountancyEntry
All Implemented Interfaces:
Persistable<AccountancyEntry.AccountancyEntryIdentifier>
Direct Known Subclasses:
OrderPaymentEntry
@Entity public class AccountancyEntry extends AbstractAggregateRoot<AccountancyEntry.AccountancyEntryIdentifier>
This class represents an accountancy entry. It is advisable to sub-class it, to define specific entry types for an accountancy, for example a OrderPaymentEntry.
Author:
Hannes Weisbach, Oliver Drotbohm

  • Constructor Details

    • AccountancyEntry

      public AccountancyEntry(javax.money.MonetaryAmount value)
      Creates a new AccountancyEntry with a specific value.
      Parameters:
      value - The value that is stored in this entry.

    • AccountancyEntry

      public AccountancyEntry(javax.money.MonetaryAmount value, String description)
      Creates a new AccountancyEntry with a specific value and a user defined description.
      Parameters:
      value - The value that is stored in this entry.
      description - A user-supplied description for this entry.

    • AccountancyEntry

      @Deprecated protected AccountancyEntry()
      Deprecated.

  • Method Details

    • hasDate

      public boolean hasDate()
      Returns whether this entry already has a date set.
      Returns:
      true if and only if this entry's date is not null.

    • getDate

      public Optional<LocalDateTime> getDate()
      Returns the date this entry was posted.
      Returns:
      the date when this entry was posted, or an empty Optional if no date is set.

    • getId

      public AccountancyEntry.AccountancyEntryIdentifier getId()
      Returns the unique identifier of this AccountancyEntry.
      Returns:
      will never be null

    • isRevenue

      public boolean isRevenue()
      Returns whether the entry is considered revenue, i.e. its value is zero or positive.
      Returns:
      whether the entry is considered revenue, i.e. its value is zero or positive.
      Since:
      7.1

    • isExpense

      public boolean isExpense()
      Returns whether the entry is considered expense, i.e. its value is negative.
      Returns:
      whether the entry is considered expense, i.e. its value is negative.
      Since:
      7.1

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getValue

      public javax.money.MonetaryAmount getValue()

    • getDescription

      public String getDescription()