Package org.salespointframework.inventory

Class InventoryItem<T extends InventoryItem<T>>

java.lang.Object

org.salespointframework.core.AbstractEntity<ID>

org.salespointframework.core.AbstractAggregateRoot<InventoryItemIdentifier>

org.salespointframework.inventory.InventoryItem<T>

All Implemented Interfaces:

Persistable<InventoryItemIdentifier>

Direct Known Subclasses:

MultiInventoryItem, UniqueInventoryItem

@MappedSuperclass
public abstract class InventoryItem<T extends InventoryItem<T>>
extends AbstractAggregateRoot<InventoryItemIdentifier>

An InventoryItem associates a product with a Quantity to keep track of how many items per product are available.

Since:

7.2

Author:

Paul Henke, Oliver Drotbohm, Martin Morgenstern

See Also:

UniqueInventoryItem, MultiInventoryItem

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InventoryItem()
protected	InventoryItem(Product product, Quantity quantity)	Creates a new InventoryItem for the given Product and Quantity.

Method Summary

Modifier and Type	Method	Description
T	decreaseQuantity(Quantity quantity)	Decreases the quantity of the current InventoryItem by the given Quantity.
InventoryItemIdentifier	getId()
protected abstract Product	getProduct()	Returns the Product this InventoryItem belongs to.
Quantity	getQuantity()
boolean	hasSufficientQuantity(Quantity quantity)	Returns whether the InventoryItem is available in exactly or more of the given quantity.
T	increaseQuantity(Quantity quantity)	Increases the quantity of the current InventoryItem by the given Quantity.
boolean	keepsTrackOf(Product product)	Returns whether the InventoryItem belongs to the given Product.
String	toString()

Methods inherited from class org.salespointframework.core.AbstractAggregateRoot

registerEvent

Methods inherited from class org.salespointframework.core.AbstractEntity

equals, hashCode, hasId, isNew

Methods inherited from class java.lang.Object

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

Constructor Details

InventoryItem

protected InventoryItem(Product product, Quantity quantity)

Creates a new InventoryItem for the given Product and Quantity.

Parameters:

quantity - the initial Quantity for this InventoryItem, must not be null.

InventoryItem

protected InventoryItem()

Method Details

getId

public final InventoryItemIdentifier getId()

hasSufficientQuantity

public boolean hasSufficientQuantity(Quantity quantity)

Returns whether the InventoryItem is available in exactly or more of the given quantity.

Parameters:

quantity - must not be null.

Returns:

decreaseQuantity

public T decreaseQuantity(Quantity quantity)

Decreases the quantity of the current InventoryItem by the given Quantity.

Parameters:

quantity - must not be null.

increaseQuantity

public T increaseQuantity(Quantity quantity)

Increases the quantity of the current InventoryItem by the given Quantity.

Parameters:

quantity - must not be null.

keepsTrackOf

public boolean keepsTrackOf(Product product)

Returns whether the InventoryItem belongs to the given Product.

Parameters:

product - must not be null.

Returns:

getProduct

protected abstract Product getProduct()

Returns the Product this InventoryItem belongs to.

Returns:

must not be null.

toString

public String toString()

Overrides:

toString in class Object

getQuantity

public Quantity getQuantity()