java.lang.Object
- org.salespointframework.core.AbstractEntity<OrderIdentifier>
- - org.salespointframework.order.Order

All Implemented Interfaces:

org.springframework.data.domain.Persistable<OrderIdentifier>
```
@Entity
public class Order
extends AbstractEntity<OrderIdentifier>
```
Author:

Thomas Dedek, Paul Henke, Oliver Gierke

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Order.OrderCancelled

static class Order.OrderCompleted

static class Order.OrderPaid

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`ChargeLine`	`add(ChargeLine chargeLine)`	Deprecated. since 7.1, use `addChargeLine(MonetaryAmount, String)` instead
`OrderLine`	`add(OrderLine orderLine)`	Deprecated. since 7.1, use `addOrderLine(Product, Quantity)` instead.
`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.AttachedChargeLine`s.
`Totalable<ChargeLine>`	`getChargeLines()`	Returns all `ChargeLine` instances registered for the current `Order`.
`Totalable<ChargeLine.AttachedChargeLine>`	`getChargeLines(int index)`	Returns all `ChargeLine.AttachedChargeLine`s for the `OrderLine` with the given index.
`Totalable<ChargeLine.AttachedChargeLine>`	`getChargeLines(OrderLine orderLine)`	Returns all `ChargeLine.AttachedChargeLine`s for the given `OrderLine`.
`javax.money.MonetaryAmount`	`getChargeLinesPrice()`	Deprecated. since 7.1, prefer `getChargeLines()`, `getAllChargeLines()` and call `PricedTotalable#getTotal()` on the result for fine grained control over which `ChargeLine`s to calculate the total for.
`LocalDateTime`	`getDateCreated()`
`OrderIdentifier`	`getId()`
`javax.money.MonetaryAmount`	`getOrderedLinesPrice()`	Deprecated. since 7.1, use `getOrderLines()` and call `Totalable.getTotal()` on the result.
`Totalable<OrderLine>`	`getOrderLines()`	Returns all `OrderLine`s 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`.
`javax.money.MonetaryAmount`	`getTotalPrice()`	Deprecated. since 7.1, use `getTotal()` instead.
`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.AttachedChargeLine`s attached to the given `OrderLine`.
`void`	`setPaymentMethod(PaymentMethod paymentMethod)`
`String`	`toString()`

Methods inherited from class org.salespointframework.core.AbstractEntity
equals, hashCode, isNew

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - 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
```
protected Order()
```
- Method Detail
  - 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
  - getTotalPrice
```
@Deprecated
public javax.money.MonetaryAmount getTotalPrice()
```
    Deprecated.
    since 7.1, use getTotal() instead.
    
    Returns the total price of the Order.
    
    Returns:
  - getOrderedLinesPrice
```
@Deprecated
public javax.money.MonetaryAmount getOrderedLinesPrice()
```
    Deprecated.
    since 7.1, use getOrderLines() and call Totalable.getTotal() on the result.
    
    Returns the total of all OrderLines.
    
    Returns:
  - getChargeLinesPrice
```
@Deprecated
public javax.money.MonetaryAmount getChargeLinesPrice()
```
    Deprecated.
    since 7.1, prefer getChargeLines(), getAllChargeLines() and call PricedTotalable#getTotal() on the result for fine grained control over which ChargeLines to calculate the total for.
    
    Returns the total of all charge lines registered with the order and order lines.
    
    Returns:
  - add
```
@Deprecated
public OrderLine add(OrderLine orderLine)
```
    Deprecated.
    since 7.1, use addOrderLine(Product, Quantity) instead.
    
    Adds an OrderLine to the Order, the OrderStatus must be OPEN.
    
    Parameters:
    
    orderLine - the OrderLine to be added.
    
    Returns:
    
    the OrderLine added.
    
    Throws:
    
    IllegalArgumentException - if orderLine is null.
  - 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.
  - add
```
@Deprecated
public ChargeLine add(ChargeLine chargeLine)
```
    Deprecated.
    since 7.1, use addChargeLine(MonetaryAmount, String) instead
    
    Adds a charge line to the Order.
    
    Parameters:
    
    chargeLine -
  - 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()
```

Modifier and Type	Class	Description
`static class`	`Order.OrderCancelled`
`static class`	`Order.OrderCompleted`
`static class`	`Order.OrderPaid`

Class Order

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.salespointframework.core.AbstractEntity

Methods inherited from class java.lang.Object

Constructor Detail

Order

Order

Order

Method Detail

getId

getOrderLines

getOrderLines

getChargeLines

getAllChargeLines

getChargeLines

getChargeLines

getTotal

getTotalPrice

getOrderedLinesPrice

getChargeLinesPrice

add

addOrderLine

remove

add

addChargeLine

addChargeLine

addChargeLine

remove

remove

removeChargeLinesFor

isPaid

isCanceled

isCompleted

isOpen

setPaymentMethod

toString

getPaymentMethod

getUserAccount

getDateCreated

getOrderStatus