org.salespointframework.core.order

Interface OrderManager

public interface OrderManager

OrderManager interface

Author:

Thomas Dedek, Paul Henke

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Order order) Adds a new Order to the OrderManager
boolean	cancelOrder(Order order) Cancels an Order, it can only be cancelled is OrderStatus is OPEN
OrderCompletionResult	completeOrder(Order order) Tries to complete this order, the OrderStatus has to be PAYED
boolean	contains(OrderIdentifier orderIdentifier) Checks if this OrderManager contains an order
<E extends Order> java.lang.Iterable<E>	find(java.lang.Class<E> clazz, org.joda.time.DateTime from, org.joda.time.DateTime to) Returns all Orders in between the dates from and to, including from and to.
<E extends Order> java.lang.Iterable<E>	find(java.lang.Class<E> clazz, OrderStatus orderStatus) Returns all Orders having the OrderStatus status.
<E extends Order> java.lang.Iterable<E>	find(java.lang.Class<E> clazz, UserAccount userAccount) Returns all Orders from the given UserAccountIdentifier.
<E extends Order> java.lang.Iterable<E>	find(java.lang.Class<E> clazz, UserAccount userAccount, org.joda.time.DateTime from, org.joda.time.DateTime to) Returns all Orders from the given UserAccountIdentifier in between the dates from and to, including from and to.
<E extends Order> E	get(java.lang.Class<E> clazz, OrderIdentifier orderIdentifier) Returns the order identified by an OrderIdentifier
boolean	payOrder(Order order) Pays the Order, OrderStatus must be OPEN and PaymentMethod must be set
void	update(Order order) Updates and persists an existing Order to the PersistentOrderManager and the Database

Method Detail

add

void add(Order order)

Adds a new Order to the OrderManager

Parameters:

order - the Order to be added

Throws:

java.lang.NullPointerException - if order is null

get

<E extends Order> E get(java.lang.Class<E> clazz,
                      OrderIdentifier orderIdentifier)

Returns the order identified by an OrderIdentifier

Parameters:

orderIdentifier - identifier of the Order to be returned

Returns:

the order if the orderIdentifier matches, otherwise null

Throws:

java.lang.NullPointerException - if orderIdentifier is null

contains

boolean contains(OrderIdentifier orderIdentifier)

Checks if this OrderManager contains an order

Parameters:

orderIdentifier - the OrderIdentifier of the Order

Returns:

true if the OrderManager contains the order, false otherwise

Throws:

java.lang.NullPointerException - if orderIdentifier is null

find

<E extends Order> java.lang.Iterable<E> find(java.lang.Class<E> clazz,
                                           OrderStatus orderStatus)

Returns all Orders having the OrderStatus status. If no orders with the specified status exist, an empty Iterable is returned.

Parameters:

orderStatus - Denoting the OrderStatus on which the Orders will be requested.

Returns:

an Iterable containing all Orders with the specified OrderStatus

Throws:

java.lang.NullPointerException - if orderStatus is null

find

<E extends Order> java.lang.Iterable<E> find(java.lang.Class<E> clazz,
                                           org.joda.time.DateTime from,
                                           org.joda.time.DateTime to)

Returns all Orders in between the dates from and to, including from and to. So every entry with an time stamp <= to and >= from is returned. If no orders within the specified time span exist, an empty Iterable is returned.

Parameters:

from - time stamp denoting the start of the requested time period

to - time stamp denoting the end of the requested time period

Returns:

an Iterable containing all Orders between from and to

Throws:

java.lang.NullPointerException - if from or to are null

find

<E extends Order> java.lang.Iterable<E> find(java.lang.Class<E> clazz,
                                           UserAccount userAccount)

Returns all Orders from the given UserAccountIdentifier. If this user has no orders, an empty Iterable is returned.

Parameters:

userAccount - Denoting the UserAccount on which the orders will be requested.

Returns:

an Iterable containing all orders from the specified user.

Throws:

java.lang.NullPointerException - if clazz oder userAccount are null

find

<E extends Order> java.lang.Iterable<E> find(java.lang.Class<E> clazz,
                                           UserAccount userAccount,
                                           org.joda.time.DateTime from,
                                           org.joda.time.DateTime to)

Returns all Orders from the given UserAccountIdentifier in between the dates from and to, including from and to. If this user has no orders in this period, an empty Iterable is returned.

Parameters:

userAccount - Denoting the UserAccountIdentifier on which the orders will be requested.

from - time stamp denoting the start of the requested time period

to - time stamp denoting the end of the requested time period

Returns:

an Iterable containing all orders from the specified user in the specified period.

Throws:

java.lang.NullPointerException - if any argument is null

completeOrder

OrderCompletionResult completeOrder(Order order)

Tries to complete this order, the OrderStatus has to be PAYED

Parameters:

order - the order to complete

Returns:

an OrderCompletionResult

update

void update(Order order)

Updates and persists an existing Order to the PersistentOrderManager and the Database

Parameters:

order - the Order to be updated

Throws:

java.lang.NullPointerException - if order is null

payOrder

boolean payOrder(Order order)

Pays the Order, OrderStatus must be OPEN and PaymentMethod must be set

Parameters:

order - the order to be payed

Returns:

true if the order could be payed

Throws:

java.lang.NullPointerException - if order is null

cancelOrder

boolean cancelOrder(Order order)

Cancels an Order, it can only be cancelled is OrderStatus is OPEN

Parameters:

order - the order to be canceled

Returns:

true if the order could be canceled

Throws:

java.lang.NullPointerException - if order is null