org.salespointframework.order

Class Order

java.lang.Object

org.salespointframework.core.AbstractEntity<OrderIdentifier>

org.salespointframework.order.Order

All Implemented Interfaces:

Serializable, org.springframework.data.domain.Persistable<OrderIdentifier>

@Entity
public class Order
extends AbstractEntity<OrderIdentifier>

Author:

Thomas Dedek, Paul Henke, Oliver Gierke

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and 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 and Description
void	add(ChargeLine chargeLine)
void	add(OrderLine orderLine) Adds an OrderLine to the Order, the OrderStatus must be OPEN.
(package private) void	cancel()
(package private) void	complete()
Iterable<ChargeLine>	getChargeLines()
org.joda.money.Money	getChargeLinesPrice()
LocalDateTime	getDateCreated()
OrderIdentifier	getIdentifier() Returns the SalespointIdentifier.
(package private) int	getNumberOfLineItems()
org.joda.money.Money	getOrderedLinesPrice()
Iterable<OrderLine>	getOrderLines()
OrderStatus	getOrderStatus()
PaymentMethod	getPaymentMethod()
org.joda.money.Money	getTotalPrice()
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
(package private) boolean	isPaymentExpected()
(package private) ProductPaymentEntry	markPaid()
void	remove(ChargeLine chargeLine)
void	remove(OrderLine orderLine)
(package private) void	setDateCreated(LocalDateTime dateTime)
void	setPaymentMethod(PaymentMethod paymentMethod)
String	toString()

Methods inherited from class org.salespointframework.core.AbstractEntity

equals, getId, hashCode, isNew

Methods inherited from class java.lang.Object

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

Constructor Detail

Order

@Deprecated
protected Order()

Deprecated.

Parameterless constructor required for JPA. Do not use.

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.

Method Detail

getIdentifier

public final OrderIdentifier getIdentifier()

Description copied from class: AbstractEntity

Returns the SalespointIdentifier.

Specified by:

getIdentifier in class AbstractEntity<OrderIdentifier>

Returns:

getOrderLines

public Iterable<OrderLine> getOrderLines()

getChargeLines

public Iterable<ChargeLine> getChargeLines()

getOrderStatus

public final OrderStatus getOrderStatus()

getUserAccount

public final UserAccount getUserAccount()

getTotalPrice

public org.joda.money.Money getTotalPrice()

getOrderedLinesPrice

public org.joda.money.Money getOrderedLinesPrice()

getChargeLinesPrice

public org.joda.money.Money getChargeLinesPrice()

getDateCreated

public final LocalDateTime getDateCreated()

add

public void add(OrderLine orderLine)

Adds an OrderLine to the Order, the OrderStatus must be OPEN.

Parameters:

orderLine - the OrderLine to be added.

Throws:

IllegalArgumentException - if orderLine is null.

remove

public void remove(OrderLine orderLine)

add

public void add(ChargeLine chargeLine)

remove

public void remove(ChargeLine chargeLine)

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

getPaymentMethod

public final PaymentMethod getPaymentMethod()

setPaymentMethod

public void setPaymentMethod(PaymentMethod paymentMethod)

complete

void complete()

cancel

void cancel()

getNumberOfLineItems

int getNumberOfLineItems()

isPaymentExpected

boolean isPaymentExpected()

markPaid

ProductPaymentEntry markPaid()

setDateCreated

void setDateCreated(LocalDateTime dateTime)

toString

public String toString()

Overrides:

toString in class Object