Package org.openwms.wms.shipping.impl

Class ShippingOrderPosition

java.lang.Object

org.ameba.integration.jpa.BaseEntity

org.ameba.integration.jpa.ApplicationEntity

org.openwms.wms.shipping.impl.AbstractShippingOrderPosition<ShippingOrderPositionSplit>

org.openwms.wms.shipping.impl.ShippingOrderPosition

All Implemented Interfaces:

Serializable, org.ameba.integration.TypedEntity<Long>

@Entity
public class ShippingOrderPosition
extends AbstractShippingOrderPosition<ShippingOrderPositionSplit>
implements Serializable

A OrderPosition.

Author:

Heiko Scherrer

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,String>	details	Arbitrary details of this Position.
private Set<ShippingOrderPositionSplit>	orderPositionSplits	All Splits created from this Position.
private @NotNull(message="{owms.wms.shp.product}",groups=Create.class) Product	product	The ordered Product.
private org.openwms.core.units.api.Measurable<?,?,?>	qtyAllocated	The quantity that has been allocated.
private org.openwms.core.units.api.Measurable<?,?,?>	qtyCrossdock	The quantity planned for cross-docking.
private @NotNull(message="{owms.wms.shp.qtyDemanded}",groups=Create.class) org.openwms.core.units.api.Measurable<?,?,?>	qtyDemanded	The quantity that was originally demanded.

Fields inherited from class org.ameba.integration.jpa.ApplicationEntity

C_ID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ShippingOrderPosition()	Used by the JPA provider.
	ShippingOrderPosition(@NotNull ShippingOrder order, @NotNull Integer positionNo, @NotNull org.openwms.core.units.api.Measurable<?,?,?> qtyDemanded, @NotNull Product product)	Create a new ShippingOrderPosition with the mandatory attributes.

Method Summary

Modifier and Type	Method	Description
void	addSplits(List<ShippingOrderPositionSplit> splits)	Add one or more Splits to this Position.
boolean	equals(Object o)	No splits.
Map<String,String>	getDetails()	Get the arbitrary details of the Position.
Set<ShippingOrderPositionSplit>	getOrderPositionSplits()	Get all created OrderPositionSplits that belong to this Position.
Product	getProduct()
org.openwms.core.units.api.Measurable	getQtyAllocated()
org.openwms.core.units.api.Measurable	getQtyCrossdock()
org.openwms.core.units.api.Measurable	getQtyDemanded()
int	hashCode()	No splits.
boolean	isAllocated()	Check if the demanded quantity of this Position is fulfilled by the sum of all Splits.
void	setDetails(Map<String,String> details)	Set arbitrary details for the Position.
void	setOrderPositionSplits(Set<ShippingOrderPositionSplit> orderPositionSplits)	Set the OrderPositionSplits of this Position.
void	setProduct(Product product)
void	setQtyAllocated(org.openwms.core.units.api.Measurable qtyAllocated)
void	setQtyCrossdock(org.openwms.core.units.api.Measurable qtyCrossdock)

Methods inherited from class org.openwms.wms.shipping.impl.AbstractShippingOrderPosition

changeOrderState, changePriority, getEarliestStartDate, getLatestDueDate, getNextAllocationDate, getNextSplitNumber, getOrder, getOrderState, getPositionNo, getPriority, getProblem, getSourceLocationGroupNames, getStartMode, getTarget, hasStartMode, isLocked, setEarliestStartDate, setLatestDueDate, setLocked, setNextAllocationDate, setOrder, setOrderState, setPersistentKey, setPositionNo, setPriority, setProblem, setSourceLocationGroupNames, setStartMode, setTarget, toString

Methods inherited from class org.ameba.integration.jpa.ApplicationEntity

getPersistentKey, hasPersistentKey, onEntityPersist, onPersist

Methods inherited from class org.ameba.integration.jpa.BaseEntity

getCreatedBy, getCreateDt, getLastModifiedBy, getLastModifiedDt, getOl, getPk, isNew, setCreatedBy, setCreateDt, setLastModifiedBy, setLastModifiedDt, setOl

Methods inherited from class java.lang.Object

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

Field Details

product

@NotNull(message="{owms.wms.shp.product}",
         groups=Create.class)
private @NotNull(message="{owms.wms.shp.product}",groups=Create.class) Product product

The ordered Product.

qtyDemanded

@NotNull(message="{owms.wms.shp.qtyDemanded}",
         groups=Create.class)
private @NotNull(message="{owms.wms.shp.qtyDemanded}",groups=Create.class) org.openwms.core.units.api.Measurable<?,?,?> qtyDemanded

The quantity that was originally demanded.

qtyCrossdock

private org.openwms.core.units.api.Measurable<?,?,?> qtyCrossdock

The quantity planned for cross-docking.

qtyAllocated

private org.openwms.core.units.api.Measurable<?,?,?> qtyAllocated

The quantity that has been allocated.

orderPositionSplits

private Set<ShippingOrderPositionSplit> orderPositionSplits

All Splits created from this Position.

details

private Map<String,String> details

Arbitrary details of this Position.

Constructor Details

ShippingOrderPosition

protected ShippingOrderPosition()

Used by the JPA provider.

ShippingOrderPosition

@ConstructorProperties({"order","positionNo","qtyDemanded","product"})
public ShippingOrderPosition(@NotNull
 @NotNull ShippingOrder order,
 @NotNull
 @NotNull Integer positionNo,
 @NotNull
 @NotNull org.openwms.core.units.api.Measurable<?,?,?> qtyDemanded,
 @NotNull
 @NotNull Product product)

Create a new ShippingOrderPosition with the mandatory attributes. @Default is for the mapper. Note that none of the arguments is checked for null, because the Mapper might need to create Entity Objects partially for partial PATCH updates.

Parameters:

order - The Order

positionNo - The position number

qtyDemanded - The ordered quantity

product - The ordered Product

Method Details

isAllocated

public boolean isAllocated()

Check if the demanded quantity of this Position is fulfilled by the sum of all Splits.

Specified by:

isAllocated in class AbstractShippingOrderPosition<ShippingOrderPositionSplit>

Returns:

true if demanded quantity is equal to assigned quantity, otherwise false

getOrderPositionSplits

public Set<ShippingOrderPositionSplit> getOrderPositionSplits()

Get all created OrderPositionSplits that belong to this Position.

Specified by:

getOrderPositionSplits in class AbstractShippingOrderPosition<ShippingOrderPositionSplit>

Returns:

The splits as Set

setOrderPositionSplits

public void setOrderPositionSplits(Set<ShippingOrderPositionSplit> orderPositionSplits)

Set the OrderPositionSplits of this Position.

Specified by:

setOrderPositionSplits in class AbstractShippingOrderPosition<ShippingOrderPositionSplit>

Parameters:

orderPositionSplits - The splits to set

addSplits

public void addSplits(List<ShippingOrderPositionSplit> splits)

Add one or more Splits to this Position.

Specified by:

addSplits in class AbstractShippingOrderPosition<ShippingOrderPositionSplit>

Parameters:

splits - Splits to add

getDetails

public Map<String,String> getDetails()

Get the arbitrary details of the Position.

Specified by:

getDetails in class AbstractShippingOrderPosition<ShippingOrderPositionSplit>

Returns:

The details as Map

setDetails

public void setDetails(Map<String,String> details)

Set arbitrary details for the Position.

Specified by:

setDetails in class AbstractShippingOrderPosition<ShippingOrderPositionSplit>

Parameters:

details - The details to set as Map

equals

public boolean equals(Object o)

No splits. All fields.

Overrides:

equals in class AbstractShippingOrderPosition<ShippingOrderPositionSplit>

hashCode

public int hashCode()

No splits. All fields.

Overrides:

hashCode in class AbstractShippingOrderPosition<ShippingOrderPositionSplit>

getProduct

public Product getProduct()

setProduct

public void setProduct(Product product)

getQtyDemanded

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

getQtyCrossdock

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

setQtyCrossdock

public void setQtyCrossdock(org.openwms.core.units.api.Measurable qtyCrossdock)

getQtyAllocated

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

setQtyAllocated

public void setQtyAllocated(org.openwms.core.units.api.Measurable qtyAllocated)