org.salespointframework.order

Interface OrderManager<T extends Order>

All Known Implementing Classes:

PersistentOrderManager

public interface OrderManager<T extends Order>

A service to manage Orders.

Author:

Thomas Dedek, Paul Henke, Oliver Gierke

Method Summary

Modifier and Type	Method and Description
boolean	cancelOrder(T order) Cancels an Order, it can only be cancelled is OrderStatus is OPEN.
OrderCompletionResult	completeOrder(T order) Tries to complete this order, the OrderStatus has to be PAID.
boolean	contains(OrderIdentifier orderIdentifier) Checks if this OrderManager contains an order.
Iterable<T>	find(LocalDateTime from, LocalDateTime to) Returns all Orders in between the dates from and to, including from and to.
Iterable<T>	find(OrderStatus orderStatus) Returns all Orders having the OrderStatus status.
Iterable<T>	find(UserAccount userAccount) Returns all Orders of the given UserAccount.
Iterable<T>	find(UserAccount userAccount, LocalDateTime from, LocalDateTime to) Returns all Orders from the given UserAccount in between the dates from and to, including from and to.
Optional<T>	get(OrderIdentifier orderIdentifier) Returns the order identified by an OrderIdentifier
boolean	payOrder(T order) Pays the Order, OrderStatus must be OPEN and PaymentMethod must be set.
T	save(T order) Saves the given Order or persists changes to it.

Method Detail

save

T save(T order)

Saves the given Order or persists changes to it.

Parameters:

order - the order to be saved, must not be null.

Returns:

get

Optional<T> get(OrderIdentifier orderIdentifier)

Returns the order identified by an OrderIdentifier

Parameters:

orderIdentifier - identifier of the Order to be returned, must not be null.

Returns:

the order if the orderIdentifier matches, otherwise Optional.empty().

contains

boolean contains(OrderIdentifier orderIdentifier)

Checks if this OrderManager contains an order.

Parameters:

orderIdentifier - the OrderIdentifier of the Order, must not be null.

Returns:

true if the OrderManager contains the order, false otherwise.

find

Iterable<T> find(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

find

Iterable<T> find(LocalDateTime from,
                 LocalDateTime 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, must not be null.

to - time stamp denoting the end of the requested time period, must not be null.

Returns:

an Iterable containing all Orders between from and to.

find

Iterable<T> find(UserAccount userAccount)

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

Parameters:

userAccount - Denoting the UserAccount on which the orders will be requested, must not be null.

Returns:

an Iterable containing all orders of the specified user.

find

Iterable<T> find(UserAccount userAccount,
                 LocalDateTime from,
                 LocalDateTime to)

Returns all Orders from the given UserAccount 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 - the UserAccount whose Orders shall be returned, must not be null.

from - time stamp denoting the start of the requested time period,must not be null.

to - time stamp denoting the end of the requested time period, must not be null.

Returns:

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

completeOrder

OrderCompletionResult completeOrder(T order)

Tries to complete this order, the OrderStatus has to be PAID.

Parameters:

order - the order to complete, must not be null.

Returns:

an OrderCompletionResult

payOrder

boolean payOrder(T order)

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

Parameters:

order - the order to be payed, must not be null.

Returns:

true if the order could be payed

cancelOrder

boolean cancelOrder(T order)

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

Parameters:

order - the order to be canceled, must not be null.

Returns:

true if the order could be canceled