Package org.salespointframework.catalog

Class Product

java.lang.Object

org.salespointframework.core.AbstractEntity<ProductIdentifier>

org.salespointframework.catalog.Product

All Implemented Interfaces:

Comparable<Product>, org.springframework.data.domain.Persistable<ProductIdentifier>

@Entity
public class Product
extends AbstractEntity<ProductIdentifier>
implements Comparable<Product>

A product.

Author:

Paul Henke, Oliver Gierke

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Product()
	Product(String name, javax.money.MonetaryAmount price)	Creates a new Product with the given name and price.
	Product(String name, javax.money.MonetaryAmount price, Metric metric)	Creates a new Product with the given name, price and Metric.

Method Summary

Modifier and Type	Method	Description
boolean	addCategory(String category)	Adds the Product to the given category.
int	compareTo(Product other)
Quantity	createQuantity(double amount)	Creates a Quantity of the given amount and the current Product's underlying Metric.
Quantity	createQuantity(long amount)	Creates a Quantity of the given amount and the current Product's underlying Metric.
org.springframework.data.util.Streamable<String>	getCategories()	Returns the categories the Product is assigned to.
ProductIdentifier	getId()
@NonNull String	getName()
@NonNull javax.money.MonetaryAmount	getPrice()
boolean	removeCategory(String category)
void	setName(@NonNull String name)
void	setPrice(@NonNull javax.money.MonetaryAmount price)
boolean	supports(Quantity quantity)	Returns whether the Product supports the given Quantity.
String	toString()
void	verify(Quantity quantity)	Verifies the given Quantity to match the one supported by the current Product.

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

Product

public Product(String name,
               javax.money.MonetaryAmount price)

Creates a new Product with the given name and price.

Parameters:

name - must not be null or empty.

price - must not be null.

Product

public Product(String name,
               javax.money.MonetaryAmount price,
               Metric metric)

Creates a new Product with the given name, price and Metric.

Parameters:

name - the name of the Product, must not be null or empty.

price - the price of the Product, must not be null.

metric - the Metric of the Product, must not be null.

Product

protected Product()

Method Detail

getId

public ProductIdentifier getId()

Specified by:

getId in interface org.springframework.data.domain.Persistable<ProductIdentifier>

getCategories

public org.springframework.data.util.Streamable<String> getCategories()

Returns the categories the Product is assigned to.

Returns:

will never be null.

addCategory

public final boolean addCategory(String category)

Adds the Product to the given category.

Parameters:

category - must not be null or empty.

Returns:

removeCategory

public final boolean removeCategory(String category)

supports

public boolean supports(Quantity quantity)

Returns whether the Product supports the given Quantity.

Parameters:

quantity -

Returns:

verify

public void verify(Quantity quantity)

Verifies the given Quantity to match the one supported by the current Product.

Parameters:

quantity -

Throws:

MetricMismatchException - in case the Product does not support the given Quantity.

createQuantity

public Quantity createQuantity(double amount)

Creates a Quantity of the given amount and the current Product's underlying Metric.

Parameters:

amount - must not be null.

Returns:

createQuantity

public Quantity createQuantity(long amount)

Creates a Quantity of the given amount and the current Product's underlying Metric.

Parameters:

amount - must not be null.

Returns:

compareTo

public int compareTo(Product other)

Specified by:

compareTo in interface Comparable<Product>

toString

public String toString()

Overrides:

toString in class Object

getName

@NonNull
public @NonNull String getName()

setName

public void setName(@NonNull
                    @NonNull String name)

getPrice

@NonNull
public @NonNull javax.money.MonetaryAmount getPrice()

setPrice

public void setPrice(@NonNull
                     @NonNull javax.money.MonetaryAmount price)