Package org.openwms.wms.inventory.allocation.spi

Class AllocationRule

java.lang.Object

org.openwms.wms.inventory.allocation.spi.AllocationRule

All Implemented Interfaces:

Serializable

public class AllocationRule
extends Object
implements Serializable

An AllocationRule encapsulates the demanded amount of Product items.

Author:

Heiko Scherrer

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final @NotNull Product	product
private final @NotNull org.openwms.core.units.api.Measurable	quantity
private final List<String>	sourceLocationGroupNames

Constructor Summary

Constructors

Constructor	Description
AllocationRule(org.openwms.core.units.api.Measurable quantity, Product product, List<String> sourceLocationGroupNames)	Create a new AllocationRule.

Method Summary

Modifier and Type	Method	Description
Product	getProduct()	Get the product.
org.openwms.core.units.api.Measurable	getQuantity()	Get the quantity.
List<String>	getSourceLocationGroupNames()	Get the names of LocationGroups where to search for the material.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

quantity

@NotNull
private final @NotNull org.openwms.core.units.api.Measurable quantity

product

@NotNull
private final @NotNull Product product

sourceLocationGroupNames

private final List<String> sourceLocationGroupNames

Constructor Details

AllocationRule

public AllocationRule(org.openwms.core.units.api.Measurable quantity,
 Product product,
 List<String> sourceLocationGroupNames)

Create a new AllocationRule.

Parameters:

quantity - The amount of Product items - non-nullable

product - The demanded Product - non-nullable

sourceLocationGroupNames - List of LocationGroup names where to search material in

Method Details

getQuantity

public org.openwms.core.units.api.Measurable getQuantity()

Get the quantity.

Returns:

the quantity.

getProduct

public Product getProduct()

Get the product.

Returns:

the product.

getSourceLocationGroupNames

public List<String> getSourceLocationGroupNames()

Get the names of LocationGroups where to search for the material.

Returns:

List of names