Package org.salespointframework.accountancy

Class AccountancyEntry

java.lang.Object

org.salespointframework.core.AbstractEntity<AccountancyEntry.AccountancyEntryIdentifier>

org.salespointframework.accountancy.AccountancyEntry

All Implemented Interfaces:

Persistable<AccountancyEntry.AccountancyEntryIdentifier>

Direct Known Subclasses:

ProductPaymentEntry

@Entity
public class AccountancyEntry
extends AbstractEntity<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 ProductPaymentEntry.

Author:

Hannes Weisbach, Oliver Gierke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccountancyEntry.AccountancyEntryIdentifier	AccountancyEntry.AccountancyEntryIdentifier serves as an identifier type for AccountancyEntry objects.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AccountancyEntry()	Deprecated.
	AccountancyEntry(javax.money.MonetaryAmount value)	Creates a new PersistentAccountancyEntry with a specific value.
	AccountancyEntry(javax.money.MonetaryAmount value, String description)	Creates a new PersistentAccountancyEntry with a specific value and a user defined description.

Method Summary

Modifier and Type	Method	Description
Optional<LocalDateTime>	getDate()
String	getDescription()
AccountancyEntry.AccountancyEntryIdentifier	getId()
javax.money.MonetaryAmount	getValue()
boolean	hasDate()	Returns whether the AccountancyEntry already has a Date set.
boolean	isExpense()	Returns whether the entry is considered expense, i.e.
boolean	isRevenue()	Returns whether the entry is considered revenue, i.e.
String	toString()

Methods inherited from class org.salespointframework.core.AbstractEntity

equals, hashCode, hasId, isNew

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AccountancyEntry

public AccountancyEntry(javax.money.MonetaryAmount value)

Creates a new PersistentAccountancyEntry 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 PersistentAccountancyEntry 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 the AccountancyEntry already has a Date set.

Returns:

getDate

public Optional<LocalDateTime> getDate()

Returns:

the DateTime when this entry was posted.

getId

public AccountancyEntry.AccountancyEntryIdentifier getId()

isRevenue

public boolean isRevenue()

Returns whether the entry is considered revenue, i.e. its value is zero or positive.

Returns:

Since:

7.1

isExpense

public boolean isExpense()

Returns whether the entry is considered expense, i.e. its value is negative.

Returns:

Since:

7.1

toString

public String toString()

Overrides:

toString in class Object

getValue

public javax.money.MonetaryAmount getValue()

getDescription

public String getDescription()