Serialized Form

Package org.openwms.common.location.api.messages

Record Class org.openwms.common.location.api.messages.LocationMO

class LocationMO extends Record implements Serializable

Serialized Fields

erpCode

String erpCode

The field for the erpCode record component.

id

String id

The field for the id record component.

Package org.openwms.common.transport.api.commands

Class org.openwms.common.transport.api.commands.MessageCommand

class MessageCommand extends Object implements Serializable

Serialized Fields

messageNumber

String messageNumber

messageOccurred

Date messageOccurred

messageText

@NotBlank String messageText

transportUnitId

String transportUnitId

type

@NotNull MessageCommand.Type type

Class org.openwms.common.transport.api.commands.TUCommand

class TUCommand extends Object implements Serializable

Serialized Fields

transportUnit

@NotNull @Valid TransportUnitMO transportUnit

type

@NotNull TUCommand.Type type

Package org.openwms.common.transport.api.messages

Class org.openwms.common.transport.api.messages.TransportUnitMO

class TransportUnitMO extends Object implements Serializable

Serialized Fields

actualLocation

@NotNull(groups={Create.class,Modified.class}) LocationMO actualLocation

The actualLocation of the TransportUnit.

actualLocationDate

Date actualLocationDate

The actualLocationDate of the TransportUnit.

barcode

@NotBlank(groups={ChangeTarget.class,Create.class,Modified.class}) String barcode

The business key of the TransportUnit.

parent

String parent

The business key of the parent TransportUnit.

pKey

@NotBlank(groups={Create.class,Request.class,Remove.class}) String pKey

The persistent key of TransportUnit.

plcCode

String plcCode

The plcCode of the TransportUnit.

state

String state

The state of the TransportUnit.

targetLocation

@NotNull(groups=ChangeTarget.class) LocationMO targetLocation

The targetLocation of the TransportUnit.

transportUnitType

@Valid @NotNull(groups=Modified.class) TransportUnitTypeMO transportUnitType

The transportUnitType of the TransportUnit.

Class org.openwms.common.transport.api.messages.TransportUnitTypeMO

class TransportUnitTypeMO extends Object implements Serializable

Serialized Fields

compatibility

String compatibility

height

int height

length

int length

payload

BigDecimal payload

type

@NotNull(groups={Create.class,Modified.class}) String type

weightMax

BigDecimal weightMax

weightTare

BigDecimal weightTare

width

int width

Package org.openwms.values

Class org.openwms.values.Problem

class Problem extends Object implements Serializable

Serialized Fields

message

String message

Message text about the Problem.

messageNo

int messageNo

Message number of the Problem.

occurred

Date occurred

Timestamp when the Problem occurred.

Package org.openwms.wms.receiving.api

Class org.openwms.wms.receiving.api.BaseReceivingOrderPositionVO

class BaseReceivingOrderPositionVO extends Object implements Serializable

Serialized Fields

createDt

LocalDateTime createDt

Timestamp when the position has been created.

details

Map<String,String> details

Arbitrary detail information on this position, might be populated with ERP information.

expectedReceiptWarehouse

String expectedReceiptWarehouse

The name of the warehouses' LocationGroup where the ReceivingOrderPosition is expected to be received.

order

ReceivingOrderVO order

orderId

@NotBlank String orderId

The unique identifier of this ReceivingOrder.

positionId

@NotNull Integer positionId

The unique position ID within an ReceivingOrder - must not be empty.

priority

int priority

The current priority of the ReceivingOrder the position belongs to.

startMode

String startMode

Optional: How the position should be processed, manually oder automatically.

state

String state

Current position state.

Class org.openwms.wms.receiving.api.CaptureDetailsVO

class CaptureDetailsVO extends Object implements Serializable

Serialized Fields

height

Integer height

length

Integer length

messageText

String messageText

weight

org.openwms.core.units.api.Weight weight

width

Integer width

Class org.openwms.wms.receiving.api.CaptureRequestVO

class CaptureRequestVO extends Object implements Serializable

Serialized Fields

details

CaptureDetailsVO details

A key/value dictionary of arbitrary values captured on the position.

Class org.openwms.wms.receiving.api.LocationVO

class LocationVO extends org.ameba.http.AbstractBase<LocationVO> implements Serializable

Serialized Fields

erpCode

@NotBlank String erpCode

Class org.openwms.wms.receiving.api.ProductVO

class ProductVO extends Object implements Serializable

Serialized Fields

baseUnit

org.openwms.core.units.api.Measurable baseUnit

Products may be defined with different base units.

description

String description

Textual descriptive text.

foreignPKey

String foreignPKey

The foreign persistent key of the Product.

label

String label

An identifying label of the Product.

sku

@NotBlank(groups=Capture.class) String sku

The product id is part of the unique business key.

Class org.openwms.wms.receiving.api.QuantityCaptureOnLocationRequestVO

class QuantityCaptureOnLocationRequestVO extends CaptureRequestVO implements Serializable

Serialized Fields

actualLocation

@NotNull(groups=CreateQuantityReceipt.class) LocationVO actualLocation

The Location where the captured items are located on.

expiresAt

ZonedDateTime expiresAt

The expiration date of the particular PackagingUnit(s) (optional).

lotId

String lotId

The business key referring to an existing Lot (optional).

product

ProductVO product

The captured Product.

productionDate

ZonedDateTime productionDate

The production date of the particular PackagingUnit(s) (optional).

quantityReceived

@NotNull(groups=CreateQuantityReceipt.class) org.openwms.core.units.api.Measurable quantityReceived

The quantity that has been received during the capturing process.

serialNumber

String serialNumber

A serial number of the captured item (optional).

uomRelation

UomRelationVO uomRelation

Describes the kind of UOM the PackagingUnit(s) are received in.

Class org.openwms.wms.receiving.api.QuantityCaptureRequestVO

class QuantityCaptureRequestVO extends CaptureRequestVO implements Serializable

Serialized Fields

loadUnitLabel

@NotBlank(groups=CreateQuantityReceipt.class) String loadUnitLabel

The unique identifier if the LoadUnit where the goods are captured in.

loadUnitType

String loadUnitType

A type in case a LoadUnit needs to be created (optional).

lotId

String lotId

The business key referring to an existing Lot (optional) .

product

@NotNull(groups=CreateQuantityReceipt.class) ProductVO product

The captured Product.

quantityReceived

@NotNull(groups=CreateQuantityReceipt.class) org.openwms.core.units.api.Measurable quantityReceived

The quantity that has been received during the capturing process.

serialNumber

String serialNumber

A serial number of the captured item (optional) .

transportUnit

@NotNull(groups=CreateQuantityReceipt.class) TransportUnitVO transportUnit

The captured TransportUnit where the goods are captured in.

Class org.openwms.wms.receiving.api.ReceivingOrderPositionVO

class ReceivingOrderPositionVO extends BaseReceivingOrderPositionVO implements Serializable

Serialized Fields

product

@NotNull(groups=CreateQuantityReceipt.class) ProductVO product

The unique SKU of the expected Product - must not be empty.

quantityExpected

@NotNull(groups=CreateQuantityReceipt.class) org.openwms.core.units.api.Measurable<?,?,?> quantityExpected

The expected quantity of the expected product - must not be null.

quantityReceived

org.openwms.core.units.api.Measurable<?,?,?> quantityReceived

The already received quantity of the product.

Class org.openwms.wms.receiving.api.ReceivingOrderVO

class ReceivingOrderVO extends org.ameba.http.AbstractBase<ReceivingOrderVO> implements Serializable

Serialized Fields

details

Map<String,String> details

Arbitrary detail information stored along an order.

expectedReceiptDate

ZonedDateTime expectedReceiptDate

When the order is expected to be received.

orderId

String orderId

The unique identifier of this ReceivingOrder.

pKey

String pKey

The persistent identifier.

positions

@Valid List<BaseReceivingOrderPositionVO> positions

A set of ReceivingOrderPositions belonging to this ReceivingOrder.

state

String state

The current state of this ReceivingOrder.

Class org.openwms.wms.receiving.api.ReceivingTransportUnitOrderPositionVO

class ReceivingTransportUnitOrderPositionVO extends BaseReceivingOrderPositionVO implements Serializable

Serialized Fields

transportUnitBK

@NotBlank(groups=CreateExpectedTUReceipt.class) String transportUnitBK

Expected receipts may also carry the unique identifier of the suppliers TransportUnit.

transportUnitTypeName

@NotBlank(groups=CreateExpectedTUReceipt.class) String transportUnitTypeName

The name of the TransportUnitType the expected TransportUnit is of.

Class org.openwms.wms.receiving.api.TransportUnitVO

class TransportUnitVO extends org.ameba.http.AbstractBase<LocationVO> implements Serializable

Serialized Fields

transportUnitId

String transportUnitId

transportUnitType

String transportUnitType

The type of TransportUnit in case it needs to be created (optional).

Class org.openwms.wms.receiving.api.TUCaptureRequestVO

class TUCaptureRequestVO extends CaptureRequestVO implements Serializable

Serialized Fields

actualLocation

@NotNull(groups={CreateBlindTUReceipt.class,CreateExpectedTUReceipt.class}) LocationVO actualLocation

The Location where the captured TransportUnit is located on.

transportUnit

@NotNull(groups={CreateBlindTUReceipt.class,CreateExpectedTUReceipt.class}) TransportUnitVO transportUnit

The actual captured TransportUnit.

Class org.openwms.wms.receiving.api.UomRelationVO

class UomRelationVO extends Object implements Serializable

Serialized Fields

pKey

String pKey

The persistent unique key.

Package org.openwms.wms.receiving.api.events

Class org.openwms.wms.receiving.api.events.ReceivingOrderPositionStateChangeEvent

class ReceivingOrderPositionStateChangeEvent extends org.openwms.core.event.RootApplicationEvent implements Serializable

Serialized Fields

state

PositionState state

Class org.openwms.wms.receiving.api.events.ReceivingOrderStateChangeEvent

class ReceivingOrderStateChangeEvent extends org.openwms.core.event.RootApplicationEvent implements Serializable

Serialized Fields

state

OrderState state

Package org.openwms.wms.receiving.api.messages

Class org.openwms.wms.receiving.api.messages.ProductMO

class ProductMO extends Object implements Serializable

Serialized Fields

baseUnit

org.openwms.core.units.api.Measurable baseUnit

description

String description

label

String label

overbookingAllowed

Boolean overbookingAllowed

pKey

String pKey

sku

String sku

Class org.openwms.wms.receiving.api.messages.ReceivingOrderMO

class ReceivingOrderMO extends Object implements Serializable

Serialized Fields

details

Map<String,String> details

Arbitrary detail information stored along an order.

orderId

String orderId

The unique identifier of this ReceivingOrder.

pKey

String pKey

The persistent identifier.

positions

List<@Valid ReceivingOrderPositionMO> positions

A set of ReceivingOrderPositions belonging to this ReceivingOrder.

state

String state

The current state of this ReceivingOrder.

Class org.openwms.wms.receiving.api.messages.ReceivingOrderPositionMO

class ReceivingOrderPositionMO extends Object implements Serializable

Serialized Fields

details

Map<String,String> details

Arbitrary detail information on this position, might by populated with ERP information.

positionId

@NotNull Integer positionId

The unique position ID within an ReceivingOrder - must not be empty.

product

ProductMO product

The unique SKU of the expected Product - must not be empty.

quantityExpected

org.openwms.core.units.api.Measurable<?,?,?> quantityExpected

The expected quantity of the expected product - must not be null.

quantityReceived

org.openwms.core.units.api.Measurable<?,?,?> quantityReceived

The already received quantity of the product.

startMode

String startMode

Optional: How the position should be processed, manually oder automatically.

state

String state

Current position state.

transportUnitBK

String transportUnitBK

Optional: Expected receipts may also carry the unique identifier of the suppliers TransportUnit.

transportUnitType

String transportUnitType

Optional: The suppliers type of TransportUnit.

Package org.openwms.wms.receiving.impl

Class org.openwms.wms.receiving.impl.AbstractReceivingOrderPosition

class AbstractReceivingOrderPosition extends org.ameba.integration.jpa.BaseEntity implements Serializable

Serialized Fields

details

Map<String,String> details

Arbitrary detail information on this position, might be populated with ERP information.

expectedReceiptWarehouse

String expectedReceiptWarehouse

The name of the warehouses' LocationGroup where the ReceivingOrderPosition is expected to be received.

latestDueDate

ZonedDateTime latestDueDate

Latest date this position can be processed.

order

ReceivingOrder order

posNo

@NotNull Integer posNo

The position number is a unique index within a single ReceivingOrder instance.

state

@NotNull PositionState state

Current position state.

Exception Class org.openwms.wms.receiving.impl.AlreadyCancelledException

class AlreadyCancelledException extends org.ameba.exception.BusinessRuntimeException implements Serializable

Exception Class org.openwms.wms.receiving.impl.CancellationDeniedException

class CancellationDeniedException extends org.ameba.exception.BusinessRuntimeException implements Serializable

Exception Class org.openwms.wms.receiving.impl.CapturingException

class CapturingException extends org.ameba.exception.BusinessRuntimeException implements Serializable

Class org.openwms.wms.receiving.impl.NextReceivingOrder

class NextReceivingOrder extends org.ameba.integration.jpa.BaseEntity implements Serializable

Serialized Fields

currentOrderId

String currentOrderId

Last given OrderId.

name

String name

Name of the Account.

prefix

String prefix

Prefix of the ReceivingOrder number.

Class org.openwms.wms.receiving.impl.ReceivingOrder

class ReceivingOrder extends org.ameba.integration.jpa.ApplicationEntity implements Serializable

Serialized Fields

details

Map<String,String> details

Arbitrary detail information on this order, might be populated with ERP information.

earliestStartDate

ZonedDateTime earliestStartDate

Earliest date the order can be started.

endDate

ZonedDateTime endDate

When the order has been finished.

expectedReceiptDate

ZonedDateTime expectedReceiptDate

When the order is expected to be received.

latestDueDate

ZonedDateTime latestDueDate

Latest date of this order can be processed.

locked

boolean locked

Property to lock/unlock an order.

• true: locked
• false: unlocked

nextAllocationDate

ZonedDateTime nextAllocationDate

Date when the order should be allocated.

orderId

String orderId

Unique order id, business key.

orderState

OrderState orderState

Current state of this order.

positions

@Valid List<AbstractReceivingOrderPosition> positions

All ReceivingOrderPosition this order has.

priority

int priority

Current priority of the order.

problem

Problem problem

Latest problem that is occurred on this order.

startDate

ZonedDateTime startDate

When the order has been started.

Class org.openwms.wms.receiving.impl.ReceivingOrderCreatedEvent

class ReceivingOrderCreatedEvent extends org.openwms.core.event.RootApplicationEvent implements Serializable

Class org.openwms.wms.receiving.impl.ReceivingOrderPosition

class ReceivingOrderPosition extends AbstractReceivingOrderPosition implements Serializable

Serialized Fields

product

@NotNull(groups=CreateQuantityReceipt.class) Product product

The expected Product to be receipt.

quantityExpected

@NotNull(groups=CreateQuantityReceipt.class) org.openwms.core.units.api.Measurable<?,?,?> quantityExpected

The quantity that is expected to be receipt.

quantityReceived

org.openwms.core.units.api.Measurable<?,?,?> quantityReceived

The receipt quantity, this might be increased at arrival.

Class org.openwms.wms.receiving.impl.ReceivingTransportUnitOrderPosition

class ReceivingTransportUnitOrderPosition extends AbstractReceivingOrderPosition implements Serializable

Serialized Fields

transportUnitBK

@NotBlank(groups=CreateExpectedTUReceipt.class) String transportUnitBK

The business key of the expected TransportUnit that is expected to be received.

transportUnitTypeName

@NotBlank(groups=CreateExpectedTUReceipt.class) String transportUnitTypeName

The name of the TransportUnitType the expected TransportUnit is of.

Package org.openwms.wms.receiving.inventory

Class org.openwms.wms.receiving.inventory.Product

class Product extends org.ameba.integration.jpa.ApplicationEntity implements Serializable

Serialized Fields

baseUnit

@NotNull org.openwms.core.units.api.Measurable<?,?,?> baseUnit

Products may be defined with different base units.

description

String description

Textual descriptive text.

foreignPKey

@NotBlank String foreignPKey

The foreign persistent key of the Product.

label

String label

An identifying label of the Product.

overbookingAllowed

@NotNull Boolean overbookingAllowed

sku

@NotBlank String sku

The product id is part of the unique business key.

Package org.openwms.wms.receiving.inventory.commands

Class org.openwms.wms.receiving.inventory.commands.EnsureProductExistsCommand

class EnsureProductExistsCommand extends org.openwms.core.event.RootApplicationEvent implements Serializable

Package org.openwms.wms.receiving.inventory.events

Class org.openwms.wms.receiving.inventory.events.InventoryProductMO

class InventoryProductMO extends Object implements Serializable

Serialized Fields

baseUnit

org.openwms.core.units.api.Measurable baseUnit

description

String description

label

String label

overbookingAllowed

Boolean overbookingAllowed

pKey

String pKey

sku

String sku

Class org.openwms.wms.receiving.inventory.events.ProductEvent

class ProductEvent extends org.openwms.core.event.RootApplicationEvent implements Serializable

Serialized Fields

type

ProductEvent.TYPE type

Package org.openwms.wms.receiving.spi.common.location

Class org.openwms.wms.receiving.spi.common.location.CommonLocationVO

class CommonLocationVO extends org.ameba.http.AbstractBase<CommonLocationVO> implements Serializable

Serialized Fields

erpCode

String erpCode

ERP code of the Location.

locationId

String locationId

Unique natural key.

Package org.openwms.wms.receiving.spi.wms.inventory

Class org.openwms.wms.receiving.spi.wms.inventory.CreatePackagingUnitCommand

class CreatePackagingUnitCommand extends Object implements Serializable

Serialized Fields

loadUnitType

String loadUnitType

luPos

String luPos

packagingUnit

@NotNull PackagingUnitVO packagingUnit

transportUnitBK

String transportUnitBK

Class org.openwms.wms.receiving.spi.wms.inventory.PackagingUnitVO

class PackagingUnitVO extends org.ameba.http.AbstractBase<PackagingUnitVO> implements Serializable

Serialized Fields

actualLocation

LocationVO actualLocation

The actualLocation the PackagingUnit is placed on.

expiresAt

ZonedDateTime expiresAt

The expiration date of this particular PackagingUnit.

height

Integer height

The current height of the PackagingUnit.

length

Integer length

The current length of the PackagingUnit.

lotId

String lotId

The business key referring to a defined Lot.

message

String message

Any kind of message placed on the PackagingUnit.

product

@NotNull ProductVO product

Ordered Product.

productionDate

ZonedDateTime productionDate

The production date of this particular PackagingUnit.

quantity

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

Quantity ordered.

serialNumber

String serialNumber

An optional serial number of the PackagingUnit.

uomRelation

UomRelationVO uomRelation

The type of PackagingUnit.

weight

org.openwms.core.units.api.Weight weight

The current weight of the PackagingUnit.

width

Integer width

The current width of the PackagingUnit.

Class org.openwms.wms.receiving.spi.wms.inventory.ProductVO

class ProductVO extends org.ameba.http.AbstractBase<ProductVO> implements Serializable

Serialized Fields

baseUnit

@NotNull(groups=Load.class) org.openwms.core.units.api.Measurable baseUnit

Products may be defined with different base units.

description

String description

Textual descriptive text.

label

@NotBlank(groups=Load.class) String label

An identifying label of the Product.

overbookingAllowed

@NotNull(groups=Load.class) Boolean overbookingAllowed

Is it allowed to receive a higher quantity as expected/announced of this Product?

pKey

@NotBlank(groups=Load.class) String pKey

The persistent unique key.

sku

@NotBlank(groups=Load.class) String sku

The product id is part of the unique business key.

Package org.openwms.wms.receiving.spi.wms.location

Class org.openwms.wms.receiving.spi.wms.location.LocationVO

class LocationVO extends org.ameba.http.AbstractBase<LocationVO> implements Serializable

Serialized Fields

erpCode

String erpCode

ERP code of the Location.

locationId

String locationId

Unique natural key.

Package org.openwms.wms.receiving.spi.wms.receiving

Exception Class org.openwms.wms.receiving.spi.wms.receiving.NotApprovedException

class NotApprovedException extends org.ameba.exception.BusinessRuntimeException implements Serializable

Package org.openwms.wms.receiving.spi.wms.transport

Class org.openwms.wms.receiving.spi.wms.transport.TransportUnitVO

class TransportUnitVO extends org.ameba.http.AbstractBase<TransportUnitVO> implements Serializable

Serialized Fields

actualLocation

LocationVO actualLocation

The actual Location.

transportUnitBK

String transportUnitBK

transportUnitType

String transportUnitType

The name of the TransportUnit's type.

Package org.openwms.wms.receiving.transport

Class org.openwms.wms.receiving.transport.TransportUnit

class TransportUnit extends org.ameba.integration.jpa.ApplicationEntity implements Serializable

Serialized Fields

actualLocation

@NotBlank String actualLocation

The current Location of the TransportUnit.

barcode

@NotBlank String barcode

Unique natural key.

foreignPKey

@NotBlank String foreignPKey

The foreign persistent key of the TransportUnit.