Package org.salespointframework.accountancy

Class OrderPaymentEntry

java.lang.Object

org.salespointframework.core.AbstractEntity<ID>

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

org.salespointframework.accountancy.AccountancyEntry

org.salespointframework.accountancy.OrderPaymentEntry

All Implemented Interfaces:

Persistable<AccountancyEntry.AccountancyEntryIdentifier>

@Entity
public class OrderPaymentEntry
extends AccountancyEntry

A OrderPaymentEntry 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
OrderPaymentEntry(Order.OrderIdentifier orderIdentifier, UserAccount.UserAccountIdentifier userAccountIdentifier, 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 OrderPaymentEntry belongs to the given Order.
Order.OrderIdentifier	getOrderIdentifier()	The Order.OrderIdentifier which this OrderPaymentEntry refers to.
PaymentMethod	getPaymentMethod()	The PaymentMethod chosen for the order belonging to this OrderPaymentEntry.
UserAccount.UserAccountIdentifier	getUserAccountIdentifier()	The identifier of the UserAccount which this OrderPaymentEntry refers to.
static OrderPaymentEntry	of(Order order, String description)	Creates a new OrderPaymentEntry for the given Order and description.
static OrderPaymentEntry	rollback(Order order, String description)	Creates a new OrderPaymentEntry 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.AbstractAggregateRoot

registerEvent

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

OrderPaymentEntry

public OrderPaymentEntry(Order.OrderIdentifier orderIdentifier,
 UserAccount.UserAccountIdentifier userAccountIdentifier,
 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 OrderPaymentEntry will refer to, must not be null.

userAccountIdentifier - the identifier of the UserAccount this OrderPaymentEntry 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 OrderPaymentEntry of(Order order,
 String description)

Creates a new OrderPaymentEntry for the given Order and description.

Parameters:

order - must not be null.

description - must not be null.

Returns:

will never be null.

rollback

public static OrderPaymentEntry rollback(Order order,
 String description)

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

Parameters:

order - must not be null.

description - must not be null.

Returns:

will never be null.

Since:

7.1

belongsTo

public boolean belongsTo(Order order)

Returns whether the OrderPaymentEntry belongs to the given Order.

Parameters:

order - must not be null.

Returns:

whether the OrderPaymentEntry belongs to the given Order.

getOrderIdentifier

public Order.OrderIdentifier getOrderIdentifier()

The Order.OrderIdentifier which this OrderPaymentEntry refers to.

getUserAccountIdentifier

public UserAccount.UserAccountIdentifier getUserAccountIdentifier()

The identifier of the UserAccount which this OrderPaymentEntry refers to.

getPaymentMethod

public PaymentMethod getPaymentMethod()

The PaymentMethod chosen for the order belonging to this OrderPaymentEntry.

toString

public String toString()

Overrides:

toString in class AccountancyEntry