Package org.salespointframework.order

Class OrderCompletionReport

java.lang.Object

org.salespointframework.order.OrderCompletionReport

All Implemented Interfaces:

Iterable<OrderCompletionReport.OrderLineCompletion>, Supplier<Stream<OrderCompletionReport.OrderLineCompletion>>, Streamable<OrderCompletionReport.OrderLineCompletion>

public class OrderCompletionReport
extends Object
implements Streamable<OrderCompletionReport.OrderLineCompletion>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OrderCompletionReport.CompletionStatus	The status of a completion.
static final class	OrderCompletionReport.OrderLineCompletion	The completion status of an OrderLine.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static OrderCompletionReport	failed(Order order)	Creates an OrderCompletionReport for an Order that's marked as failed.
static OrderCompletionReport	forCompletions(Order order, Iterable<OrderCompletionReport.OrderLineCompletion> completions)	Creates a new OrderCompletionReport for the given Order and OrderCompletionReport.OrderLineCompletions.
@NonNull Order	getOrder()
@NonNull OrderCompletionReport.CompletionStatus	getStatus()
boolean	hasErrors()	Returns whether there report contains any errors.
int	hashCode()
Iterator<OrderCompletionReport.OrderLineCompletion>	iterator()
OrderCompletionReport	onError(Function<OrderCompletionReport,? extends RuntimeException> exception)	Applies the given Function to produce an exception in case the report has errors.
static OrderCompletionReport	success(Order order)	Creates an OrderCompletionReport representing a successful verification of the given Order.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.springframework.data.util.Streamable

and, and, and, and, filter, flatMap, get, isEmpty, map, stream, toList, toSet

Method Details

success

public static OrderCompletionReport success(Order order)

Creates an OrderCompletionReport representing a successful verification of the given Order.

Parameters:

order - must not be null.

Returns:

will never be null.

failed

public static OrderCompletionReport failed(Order order)

Creates an OrderCompletionReport for an Order that's marked as failed.

Parameters:

order - must not be null.

Returns:

will never be null.

forCompletions

public static OrderCompletionReport forCompletions(Order order,
 Iterable<OrderCompletionReport.OrderLineCompletion> completions)

Creates a new OrderCompletionReport for the given Order and OrderCompletionReport.OrderLineCompletions.

Parameters:

order - must not be null.

completions - must not be null.

Returns:

will never be null.

hasErrors

public boolean hasErrors()

Returns whether there report contains any errors. If true, clients should go ahead and inspect the report for OrderCompletionReport.OrderLineCompletion (e.g. using Streamable.stream() to access the individual completions).

Returns:

onError

public OrderCompletionReport onError(Function<OrderCompletionReport,? extends RuntimeException> exception)

Applies the given Function to produce an exception in case the report has errors.

Parameters:

exception - must not be null.

Since:

7.1

iterator

public Iterator<OrderCompletionReport.OrderLineCompletion> iterator()

Specified by:

iterator in interface Iterable<OrderCompletionReport.OrderLineCompletion>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getOrder

@NonNull
public @NonNull Order getOrder()

getStatus

@NonNull
public @NonNull OrderCompletionReport.CompletionStatus getStatus()