Package org.salespointframework.order

Class Order

java.lang.Object

org.salespointframework.core.AbstractEntity<ID>

org.salespointframework.core.AbstractAggregateRoot<OrderIdentifier>

org.salespointframework.order.Order

All Implemented Interfaces:

Persistable<OrderIdentifier>

@Entity
public class Order
extends AbstractAggregateRoot<OrderIdentifier>

Author:

Thomas Dedek, Paul Henke, Oliver Gierke

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Order()	Deprecated.
	Order(UserAccount userAccount)	Creates a new Order
	Order(UserAccount userAccount, PaymentMethod paymentMethod)	Creates a new Order for the given UserAccount and PaymentMethod.

Method Summary

Modifier and Type	Method	Description
ChargeLine	addChargeLine(javax.money.MonetaryAmount price, String description)	Adds a ChargeLine with the given price and description to the Order.
ChargeLine.AttachedChargeLine	addChargeLine(javax.money.MonetaryAmount price, String description, int index)	Adds an ChargeLine.AttachedChargeLine with the given price and description to the OrderLine with the given index.
ChargeLine.AttachedChargeLine	addChargeLine(javax.money.MonetaryAmount price, String description, OrderLine orderLine)	Adds an ChargeLine.AttachedChargeLine with the given price and description to the given OrderLine.
OrderLine	addOrderLine(Product product, Quantity quantity)	Adds an OrderLine for the given with the given Quantity.
Totalable<ChargeLine>	getAllChargeLines()	Returns all ChargeLine instances, i.e. both standard ones and ChargeLine.AttachedChargeLines.
Totalable<ChargeLine>	getChargeLines()	Returns all ChargeLine instances registered for the current Order.
Totalable<ChargeLine.AttachedChargeLine>	getChargeLines(int index)	Returns all ChargeLine.AttachedChargeLines for the OrderLine with the given index.
Totalable<ChargeLine.AttachedChargeLine>	getChargeLines(OrderLine orderLine)	Returns all ChargeLine.AttachedChargeLines for the given OrderLine.
LocalDateTime	getDateCreated()
OrderIdentifier	getId()
Totalable<OrderLine>	getOrderLines()	Returns all OrderLines of the Order.
Totalable<OrderLine>	getOrderLines(Product product)	Returns all OrderLine instances that refer to the given Product.
OrderStatus	getOrderStatus()
PaymentMethod	getPaymentMethod()
javax.money.MonetaryAmount	getTotal()	Returns the total price of the Order.
UserAccount	getUserAccount()
boolean	isCanceled()	Convenience method for checking if an order has the status CANCELLED
boolean	isCompleted()	Convenience method for checking if an order has the status COMPLETED
boolean	isOpen()	Convenience method for checking if an order has the status OPEN
boolean	isPaid()	Convenience method for checking if an order has the status PAID
void	remove(ChargeLine chargeLine)
void	remove(ChargeLine.AttachedChargeLine chargeLine)	Removes the given ChargeLine.AttachedChargeLine from the Order.
void	remove(OrderLine orderLine)	Removes the given OrderLine as well as all ChargeLine.AttachedChargeLine associated with it.
void	removeChargeLinesFor(OrderLine orderLine)	Removes all ChargeLine.AttachedChargeLines attached to the given OrderLine.
void	setPaymentMethod(PaymentMethod paymentMethod)
String	toString()

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

Order

public Order(UserAccount userAccount)

Creates a new Order

Parameters:

userAccount - The UserAccount connected to this order, must not be null.

Order

public Order(UserAccount userAccount, PaymentMethod paymentMethod)

Creates a new Order for the given UserAccount and PaymentMethod.

Parameters:

userAccount - The UserAccount connected to this order, must not be null.

paymentMethod - The PaymentMethod connected to this order, must not be null.

Order

@Deprecated protected Order()

Deprecated.

Method Details

getId

public OrderIdentifier getId()

getOrderLines

public Totalable<OrderLine> getOrderLines()

Returns all OrderLines of the Order.

Returns:

getOrderLines

public Totalable<OrderLine> getOrderLines(Product product)

Returns all OrderLine instances that refer to the given Product.

Parameters:

product - must not be null.

Returns:

Since:

7.1

getChargeLines

public Totalable<ChargeLine> getChargeLines()

Returns all ChargeLine instances registered for the current Order.

Returns:

getAllChargeLines

public Totalable<ChargeLine> getAllChargeLines()

Returns all ChargeLine instances, i.e. both standard ones and ChargeLine.AttachedChargeLines.

Returns:

getChargeLines

public Totalable<ChargeLine.AttachedChargeLine> getChargeLines(int index)

Returns all ChargeLine.AttachedChargeLines for the OrderLine with the given index.

Parameters:

index - must be in the range of OrderLines.

Returns:

Since:

7.1

getChargeLines

public Totalable<ChargeLine.AttachedChargeLine> getChargeLines(OrderLine orderLine)

Returns all ChargeLine.AttachedChargeLines for the given OrderLine.

Parameters:

orderLine - must not be null.

Returns:

Since:

7.1

getTotal

public javax.money.MonetaryAmount getTotal()

Returns the total price of the Order.

Returns:

Since:

7.1

addOrderLine

public OrderLine addOrderLine(Product product, Quantity quantity)

Adds an OrderLine for the given with the given Quantity.

Parameters:

product - must not be null.

quantity - must not be null.

Returns:

the OrderLine added.

Since:

7.1

remove

public void remove(OrderLine orderLine)

Removes the given OrderLine as well as all ChargeLine.AttachedChargeLine associated with it.

Parameters:

orderLine - must not be null.

addChargeLine

public ChargeLine addChargeLine(javax.money.MonetaryAmount price, String description)

Adds a ChargeLine with the given price and description to the Order.

Parameters:

price - must not be null.

description - must not be null.

Returns:

the ChargeLine created.

Since:

7.1

addChargeLine

public ChargeLine.AttachedChargeLine addChargeLine(javax.money.MonetaryAmount price, String description, int index)

Adds an ChargeLine.AttachedChargeLine with the given price and description to the OrderLine with the given index.

Parameters:

price - must not be null.

description - must not be null.

index - must be within the range of OrderLines already registered.

Returns:

the ChargeLine.AttachedChargeLine created.

Since:

7.1

addChargeLine

public ChargeLine.AttachedChargeLine addChargeLine(javax.money.MonetaryAmount price, String description, OrderLine orderLine)

Adds an ChargeLine.AttachedChargeLine with the given price and description to the given OrderLine.

Parameters:

price - must not be null.

description - must not be null.

orderLine - must not be null.

Returns:

the ChargeLine.AttachedChargeLine created.

Since:

7.1

remove

public void remove(ChargeLine chargeLine)

remove

public void remove(ChargeLine.AttachedChargeLine chargeLine)

Removes the given ChargeLine.AttachedChargeLine from the Order.

Parameters:

chargeLine - must not be null.

Since:

7.1

removeChargeLinesFor

public void removeChargeLinesFor(OrderLine orderLine)

Removes all ChargeLine.AttachedChargeLines attached to the given OrderLine.

Parameters:

orderLine - must not be null.

Since:

7.1

isPaid

public boolean isPaid()

Convenience method for checking if an order has the status PAID

Returns:

true if OrderStatus is PAID, otherwise false

isCanceled

public boolean isCanceled()

Convenience method for checking if an order has the status CANCELLED

Returns:

true if OrderStatus is CANCELLED, otherwise false

isCompleted

public boolean isCompleted()

Convenience method for checking if an order has the status COMPLETED

Returns:

true if OrderStatus is COMPLETED, otherwise false

isOpen

public boolean isOpen()

Convenience method for checking if an order has the status OPEN

Returns:

true if OrderStatus is OPEN, otherwise false

setPaymentMethod

public void setPaymentMethod(PaymentMethod paymentMethod)

toString

public String toString()

Overrides:

toString in class Object

getPaymentMethod

public PaymentMethod getPaymentMethod()

getUserAccount

public UserAccount getUserAccount()

getDateCreated

public LocalDateTime getDateCreated()

getOrderStatus

public OrderStatus getOrderStatus()