Package org.salespointframework.accountancy

Class ProductPaymentEntry

java.lang.Object

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

org.salespointframework.accountancy.AccountancyEntry

org.salespointframework.accountancy.ProductPaymentEntry

All Implemented Interfaces:

Persistable<AccountancyEntry.AccountancyEntryIdentifier>

@Entity
public class ProductPaymentEntry
extends AccountancyEntry

A ProductPaymentEntry is used to store information of payments of orders.

Author:

Hannes Weisbach, Thomas Dedek, Oliver Gierke

Nested Class Summary

Nested classes/interfaces inherited from class org.salespointframework.accountancy.AccountancyEntry

AccountancyEntry.AccountancyEntryIdentifier

Constructor Summary

Constructors

Constructor	Description
ProductPaymentEntry(Order.OrderIdentifier orderIdentifier, UserAccount userAccount, javax.money.MonetaryAmount amount, String description, PaymentMethod paymentMethod)	A ProductPaymentEntry is constructed for a specific Order.OrderIdentifier attached to it.

Method Summary

Modifier and Type	Method	Description
boolean	belongsTo(Order order)	Returns whether the ProductPaymentEntry belongs to the given Order.
Order.OrderIdentifier	getOrderIdentifier()	The Order.OrderIdentifier which this ProductPaymentEntry refers to.
PaymentMethod	getPaymentMethod()	The PaymentMethod chosen for the order belonging to this ProductPaymentEntry
UserAccount	getUserAccount()	The UserAccount which this ProductPaymentEntry refers to.
static ProductPaymentEntry	of(Order order, String description)
static ProductPaymentEntry	rollback(Order order, String description)	Creates a new ProductPaymentEntry that rolls back the payment for the given Order.
String	toString()

Methods inherited from class org.salespointframework.accountancy.AccountancyEntry

getDate, getDescription, getId, getValue, hasDate, isExpense, isRevenue

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

ProductPaymentEntry

public ProductPaymentEntry(Order.OrderIdentifier orderIdentifier,
 UserAccount userAccount,
 javax.money.MonetaryAmount amount,
 String description,
 PaymentMethod paymentMethod)

A ProductPaymentEntry is constructed for a specific Order.OrderIdentifier attached to it. This entry saves also the UserAccount.UserAccountIdentifier and the specified amount that was paid.

Parameters:

orderIdentifier - the Order.OrderIdentifier to which this ProductPaymentEntry will refer to, must not be null.

userAccount - the UserAccount to which this ProductPaymentEntry will refer to, must not be null.

amount - the MonetaryAmount that was paid, must not be null.

description - textual description of the payment entry, must not be null.

paymentMethod - must not be null.

Method Details

of

public static ProductPaymentEntry of(Order order,
 String description)

rollback

public static ProductPaymentEntry rollback(Order order,
 String description)

Creates a new ProductPaymentEntry that rolls back the payment for the given Order.

Parameters:

order - must not be null.

description - must not be null.

Returns:

Since:

7.1

belongsTo

public boolean belongsTo(Order order)

Returns whether the ProductPaymentEntry belongs to the given Order.

Parameters:

order - must not be null.

Returns:

getOrderIdentifier

public Order.OrderIdentifier getOrderIdentifier()

The Order.OrderIdentifier which this ProductPaymentEntry refers to.

getUserAccount

public UserAccount getUserAccount()

The UserAccount which this ProductPaymentEntry refers to.

getPaymentMethod

public PaymentMethod getPaymentMethod()

The PaymentMethod chosen for the order belonging to this ProductPaymentEntry

toString

public String toString()

Overrides:

toString in class AccountancyEntry