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:

OrderPaymentEntry

@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 OrderPaymentEntry.

Author:

Hannes Weisbach, Oliver Drotbohm

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Optional<LocalDateTime>	getDate()	Returns the date this entry was posted.
String	getDescription()
AccountancyEntry.AccountancyEntryIdentifier	getId()	Returns the unique identifier of this AccountancyEntry.
javax.money.MonetaryAmount	getValue()
boolean	hasDate()	Returns whether this entry already has a date set.
boolean	isExpense()	Returns whether the entry is considered expense, i.e. its value is negative.
boolean	isRevenue()	Returns whether the entry is considered revenue, i.e. its value is zero or positive.
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 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()