Serialized Form

Package org.openwms.common

Class org.openwms.common.SimpleLink

class SimpleLink extends org.springframework.hateoas.Link implements Serializable

Exception Class org.openwms.common.StateChangeException

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

Package org.openwms.common.account

Class org.openwms.common.account.Account

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

Serialized Fields

defaultAccount

boolean defaultAccount

Flag to set the Account as default.

identifier

@NotEmpty String identifier

Unique identifier.

name

@NotEmpty String name

Name of the Account.

Package org.openwms.common.account.api

Class org.openwms.common.account.api.AccountVO

class AccountVO extends org.springframework.hateoas.RepresentationModel<AccountVO> implements Serializable

Serialized Fields

createDt

LocalDateTime createDt

Timestamp when the Account has been created.

identifier

@NotBlank String identifier

Unique identifier.

name

@NotBlank String name

Name.

pKey

String pKey

The persistent technical key of the Account.

Package org.openwms.common.location

Class org.openwms.common.location.Location

class Location extends Target implements Serializable

Serialized Fields

account

Account account

The Location might be assigned to an Account.

classification

@Size(max=255) String classification

The Location may be classified, like 'hazardous'.

consideredInAllocation

Boolean consideredInAllocation

Determines whether the Location is considered in the allocation procedure.

• true : The Location is considered in storage calculation by an allocation procedure.
• false : The Location is not considered in the allocation process.

description

@Size(max=255) String description

Description of the Location.

erpCode

String erpCode

ERP code of the Location.

group

String group

Some group the Location belongs to.

incomingActive

boolean incomingActive

Signals the incoming state of the Location. Locations which are blocked for incoming movements do not accept TransportUnits.

• true : Location is ready to pick up TransportUnits.
• false: Location is locked, and cannot pick up TransportUnits.

labels

@Size(max=1024) List<String> labels

A Location can be assigned to a particular labels.

lastMovement

LocalDateTime lastMovement

Date of last movement. When a TransportUnit is moving to or away from the Location, lastMovement is updated. This is useful to get the history of TransportUnits as well as for inventory calculation.

locationGroup

LocationGroup locationGroup

The LocationGroup the Location belongs to.

locationGroupCountingActive

Boolean locationGroupCountingActive

Shall the Location be included in the calculation of TransportUnits of the parent LocationGroup.

• true : Location is included in calculation of TransportUnits.
• false: Location is not included in calculation of TransportUnits.

locationId

@NotNull LocationPK locationId

Unique natural key.

locationType

LocationType locationType

The LocationType the Location belongs to.

maximumWeight

BigDecimal maximumWeight

Maximum allowed weight on the Location.

messages

Set<Message> messages

Stored Messages on the Location.

noMaxTransportUnits

int noMaxTransportUnits

Maximum number of TransportUnits allowed on the Location.

outgoingActive

boolean outgoingActive

Signals the outgoing state of the Location. Locations which are blocked for outgoing do not accept to move TransportUnits away.

• true : Location is enabled for outgoing TransportUnits.
• false: Location is locked, TransportUnits can't leave the Location.

plcCode

String plcCode

PLC code of the Location.

plcState

int plcState

The PLC is able to change the state of a Location. This property stores the last state, received from the PLC.

• 0 : No PLC error, everything okay
• < 0: Not defined
• > 0: Some defined error code

sortOrder

Integer sortOrder

Sort order index used by strategies for putaway, or picking.

stockZone

String stockZone

Might be assigned to a particular zone in stock.

Class org.openwms.common.location.LocationGroup

class LocationGroup extends Target implements Serializable

Serialized Fields

account

Account account

The LocationGroup might be assigned to an Account.

description

String description

Description of the LocationGroup.

groupStateIn

@NotNull LocationGroupState groupStateIn

State of infeed, controlled by the subsystem only.

groupStateOut

@NotNull LocationGroupState groupStateOut

State of outfeed.

groupType

String groupType

A type can be assigned to a LocationGroup.

locationGroupCountingActive

boolean locationGroupCountingActive

Is the LocationGroup included in the calculation of TransportUnits.

locationGroups

Set<LocationGroup> locationGroups

Child LocationGroups.

locations

Set<Location> locations

Child Locations.

maxFillLevel

float maxFillLevel

Maximum fill level of the LocationGroup.

name

@NotBlank @Size(min=1,max=255) String name

Unique identifier of a LocationGroup.

operationMode

@NotBlank String operationMode

The operation mode is controlled by the subsystem and defines the physical mode a LocationGroup is currently able to operate in.

parent

LocationGroup parent

Parent LocationGroup.

stateInLocker

LocationGroup stateInLocker

References the LocationGroup that locked this LocationGroup for infeed.

stateOutLocker

LocationGroup stateOutLocker

References the LocationGroup that locked this LocationGroup for outfeed.

subsystem

Subsystem subsystem

The subsystem like a PLC, that manages this LocationGroup.

Class org.openwms.common.location.LocationPK

class LocationPK extends Object implements Serializable

Serialized Fields

aisle

@Size(max=4) String aisle

Expresses the aisle the Location belongs to.

area

@Size(max=4) String area

Expresses the area the Location belongs to.

x

@Size(max=4) String x

Expresses the x-dimension the Location belongs to.

y

@Size(max=4) String y

Expresses the y-dimension the Location belongs to.

z

@Size(max=4) String z

Expresses the z-dimension the Location belongs to.

Class org.openwms.common.location.LocationType

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

Serialized Fields

description

String description

Description of the LocationType.

height

int height

Height of the LocationType.

length

int length

Length of the LocationType.

type

String type

Type of the LocationType (unique).

width

int width

Width of the LocationType.

Class org.openwms.common.location.Message

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

Serialized Fields

messageNo

int messageNo

Message number.

messageText

String messageText

Message description text.

Class org.openwms.common.location.Subsystem

class Subsystem extends Object implements Serializable

Serialized Fields

systemCode

String systemCode

Subsequential code of the subsystem (e.g. PLC), tied to this LocationGroup. A subsystem may be named after a name and a code, like PLCCONV_01, where PLCCONV is the name of the subsystem group and the code _01 is a unique number in this group.

systemName

String systemName

Name of the subsystem (e.g. PLC), tied to this LocationGroup. A subsystem may be named after a name and a code, like PLCCONV_01, where PLCCONV is the name of the subsystem group and the code _01 is a unique number in this group.

Class org.openwms.common.location.Target

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

Package org.openwms.common.location.api

Class org.openwms.common.location.api.ErrorCodeVO

class ErrorCodeVO extends Object implements Serializable

Serialized Fields

errorCode

String errorCode

plcState

Integer plcState

Class org.openwms.common.location.api.LocationGroupVO

class LocationGroupVO extends org.springframework.hateoas.RepresentationModel<LocationGroupVO> implements Serializable

Serialized Fields

accountId

String accountId

The LocationGroup might be assigned to an Account.

children

List<LocationGroupVO> children

Child LocationGroups.

createDt

LocalDateTime createDt

Timestamp when the LocationGroup has been created.

description

String description

Description of the LocationGroup.

groupStateIn

LocationGroupState groupStateIn

Infeed state, controlled by the subsystem only.

groupStateOut

LocationGroupState groupStateOut

Outfeed state.

groupType

String groupType

A type can be assigned to a LocationGroup.

name

@NotBlank String name

Unique identifier of the LocationGroup.

operationMode

@NotBlank(groups=Create.class) String operationMode

The operation mode is controlled by the subsystem and defines the physical mode a LocationGroup is currently able to operate in.

parent

String parent

Parent LocationGroup.

pKey

String pKey

The persistent technical key of the LocationGroup.

Class org.openwms.common.location.api.LocationTypeVO

class LocationTypeVO extends org.springframework.hateoas.RepresentationModel<LocationTypeVO> implements Serializable

Serialized Fields

createDt

LocalDateTime createDt

Timestamp when the LocationType has been created.

description

String description

A descriptive text.

height

int height

Height.

length

int length

Length.

pKey

String pKey

The persistent technical key of the LocationType.

type

@NotBlank String type

Unique identifier.

width

int width

Width.

Class org.openwms.common.location.api.LocationVO

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

Serialized Fields

accountId

String accountId

The ID of the Account, the Location is assigned to.

createDt

LocalDateTime createDt

Timestamp when the Location has been created.

erpCode

@NotBlank(groups=Create.class) String erpCode

ERP code of the Location.

incomingActive

Boolean incomingActive

Whether the Location is enabled for incoming movements (read-only).

locationGroupName

@NotBlank(groups=Create.class) String locationGroupName

The name of LocationGroup the Location belongs to.

locationId

@NotBlank String locationId

Unique natural key.

outgoingActive

Boolean outgoingActive

Whether the Location is enabled for outgoing movements (read-only).

pKey

String pKey

The persistent technical key of the Location.

plcCode

@NotBlank(groups=Create.class) String plcCode

PLC code of the Location.

plcState

Integer plcState

The current state, set by the PLC system (read-only).

sortOrder

Integer sortOrder

Sort order index used by strategies for putaway, or picking.

stockZone

String stockZone

Might be assigned to a particular zone in stock.

type

@NotBlank(groups=Create.class) String type

The name of the LocationType the Location belongs to.

Package org.openwms.common.location.api.commands

Class org.openwms.common.location.api.commands.LocationCommand

class LocationCommand extends Object implements Serializable

Serialized Fields

location

@Valid LocationMO location

type

LocationCommand.Type type

Record Class org.openwms.common.location.api.commands.LocationReplicaRegistration

class LocationReplicaRegistration extends Record implements Serializable

Serialized Fields

applicationName

@NotBlank String applicationName

The field for the applicationName record component.

removeEndpoint

String removeEndpoint

The field for the removeEndpoint record component.

requestRemovalEndpoint

String requestRemovalEndpoint

The field for the requestRemovalEndpoint record component.

Class org.openwms.common.location.api.commands.RevokeLocationRemoveCommand

class RevokeLocationRemoveCommand extends Object implements Serializable

Serialized Fields

pKey

String pKey

Package org.openwms.common.location.api.events

Class org.openwms.common.location.api.events.LocationEvent

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

Serialized Fields

type

LocationEvent.LocationEventType type

Class org.openwms.common.location.api.events.LocationGroupEvent

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

Serialized Fields

type

LocationGroupEvent.LocationGroupEventType type

Class org.openwms.common.location.api.events.TargetEvent

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

Serialized Fields

lockType

LockType lockType

operationMode

LockMode operationMode

reAllocation

Boolean reAllocation

targetBK

String targetBK

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

Class org.openwms.common.location.api.messages.LocationGroupMO

class LocationGroupMO extends Object implements Serializable

serialVersionUID:

-1321439795390598796L

Serialized Fields

accountId

String accountId

The accountId the LocationGroup belongs to.

incomingActive

boolean incomingActive

If the LocationGroup is available for inbound operations.

name

String name

The business key of the LocationGroup.

operationMode

String operationMode

The current operation mode the LocationGroup is set to.

outgoingActive

boolean outgoingActive

If the LocationGroup is available for outbound operations.

parent

String parent

The business key of the parent LocationGroup .

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

class LocationMO extends Record implements Serializable

Serialized Fields

accountId

String accountId

The field for the accountId record component.

erpCode

String erpCode

The field for the erpCode record component.

id

String id

The field for the id record component.

incomingActive

Boolean incomingActive

The field for the incomingActive record component.

locationGroupName

String locationGroupName

The field for the locationGroupName record component.

outgoingActive

Boolean outgoingActive

The field for the outgoingActive record component.

pKey

@NotEmpty(groups=SetLocationEmpty.class) String pKey

The field for the pKey record component.

plcCode

String plcCode

The field for the plcCode record component.

plcState

Integer plcState

The field for the plcState record component.

Package org.openwms.common.location.events

Class org.openwms.common.location.events.DeletionFailedEvent

class DeletionFailedEvent extends org.springframework.context.ApplicationEvent implements Serializable

Package org.openwms.common.location.impl.registration

Class org.openwms.common.location.impl.registration.ReplicaRegistry

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

Serialized Fields

applicationName

@NotBlank String applicationName

registeredAt

LocalDateTime registeredAt

removalEndpoint

String removalEndpoint

requestRemovalEndpoint

String requestRemovalEndpoint

state

@NotBlank String state

unRegisteredAt

LocalDateTime unRegisteredAt

Package org.openwms.common.transport

Class org.openwms.common.transport.TransportUnit

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

Serialized Fields

actualLocation

Location actualLocation

The current Location of the TransportUnit.

actualLocationDate

LocalDateTime actualLocationDate

Date when the TransportUnit has been moved to the current Location.

barcode

Barcode barcode

Unique natural key.

children

Set<TransportUnit> children

A set of all child TransportUnits, ordered by id.

empty

Boolean empty

Indicates whether the TransportUnit is empty or not (nullable).

errors

List<UnitError> errors

A List of errors occurred on the TransportUnit.

groupName

String groupName

A TransportUnit may belong to a group of TransportUnits.

inventoryDate

LocalDateTime inventoryDate

Date of last inventory check.

inventoryUser

String inventoryUser

The User who performed the last inventory action on the TransportUnit.

parent

TransportUnit parent

Owning TransportUnit.

reservations

List<TransportUnitReservation> reservations

Tracks all active TransportUnitReservations on this TransportUnit.

state

String state

State of the TransportUnit.

targetLocation

Location targetLocation

The target Location of the TransportUnit. This property is set when a TransportOrder is started.

transportUnitType

TransportUnitType transportUnitType

The TransportUnitType of the TransportUnit.

weight

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

Weight of the TransportUnit.

Class org.openwms.common.transport.TransportUnitType

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

Serialized Fields

compatibility

String compatibility

Characteristic used to hold specific compatibility attributes.
Example:
'isn't compatible with...' or 'is compatible with ...' or 'type owns another type ...'

description

String description

Description for this type.

height

int height

Height of the TransportUnitType.

length

int length

Length of the TransportUnitType.

payload

BigDecimal payload

Effective weight of the TransportUnitType's payload.

transportUnits

Set<TransportUnit> transportUnits

A collection of all TransportUnits belonging to this type.

type

String type

Unique natural key.

typePlacingRules

Set<TypePlacingRule> typePlacingRules

A Set of TypePlacingRules store all possible LocationType s of the TransportUnitType.

typeStackingRules

Set<TypeStackingRule> typeStackingRules

Describes other TransportUnitTypes and how many of these may be stacked on the TransportUnitType.

weightMax

BigDecimal weightMax

Maximum allowed weight of the TransportUnitType.

weightTare

BigDecimal weightTare

Tare weight of the TransportUnitType.

width

int width

Width of the TransportUnitType.

Class org.openwms.common.transport.TypePlacingRule

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

Serialized Fields

allowedLocationType

LocationType allowedLocationType

An allowed LocationType on which the owning TransportUnitType may be placed (not-null).

privilegeLevel

int privilegeLevel

The privilegeLevel defines a priority to describe which TransportUnitType can be placed on which LocationType.

A value of 0 means the lowest priority. Increasing the privilegeLevel implies a higher priority and means the TransportUnitType can be placed to the LocationType with the highest privilegeLevel.

To forbid a TransportUnitType on a certain LocationType the privilegeLevel must be set to -1.

(not-null)

transportUnitType

TransportUnitType transportUnitType

Parent TransportUnitType (not-null).

Class org.openwms.common.transport.TypeStackingRule

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

Serialized Fields

allowedTransportUnitType

TransportUnitType allowedTransportUnitType

The allowed TransportUnitType that may be placed on the owning TransportUnitType (not-null).

baseTransportUnitType

TransportUnitType baseTransportUnitType

Parent TransportUnitType.

noTransportUnits

int noTransportUnits

Number of TransportUnitTypes that may be placed on the owning TransportUnitType (not-null).

Class org.openwms.common.transport.UnitError

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

Serialized Fields

errorNo

String errorNo

Error number.

errorText

String errorText

Error message text.

transportUnit

TransportUnit transportUnit

Package org.openwms.common.transport.allocation.api

Class org.openwms.common.transport.allocation.api.AllocationVO

class AllocationVO extends Object implements Serializable

Serialized Fields

actualErpCode

String actualErpCode

reservationId

String reservationId

transportUnitBK

String transportUnitBK

Package org.openwms.common.transport.api

Class org.openwms.common.transport.api.TransportUnitTypeVO

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

Serialized Fields

createDt

LocalDateTime createDt

Timestamp when the TransportUnitType has been created.

description

String description

Description for the TransportUnitType.

height

@NotBlank String height

Height of the TransportUnitType.

length

@NotBlank String length

Length of the TransportUnitType.

pKey

@NotBlank String pKey

The persistent key.

type

@NotBlank String type

Unique natural key.

width

@NotBlank String width

Width of the TransportUnitType.

Class org.openwms.common.transport.api.TransportUnitVO

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

Serialized Fields

actualLocation

@NotNull(message="{owms.common.common.tu.actualLocation}",groups={Create.class,Update.class}) LocationVO actualLocation

The current Location of the TransportUnit.

actualLocationDate

LocalDateTime actualLocationDate

Date when the TransportUnit has been moved to the current Location.

barcode

@NotBlank(message="{owms.common.common.tu.barcode}",groups={Create.class,Update.class}) String barcode

Unique natural key.

groupId

String groupId

A TransportUnit may belong to a group of TransportUnits.

pKey

@NotBlank(groups=Update.class) String pKey

The persistent key.

state

@NotBlank(message="{owms.common.common.tu.state}",groups=Update.class) String state

The state of the TransportUnit.

targetLocation

LocationVO targetLocation

The target Location of the TransportUnit.

transportUnitType

@NotNull(message="{owms.common.common.tu.transportUnitType}",groups={Create.class,WithTuT.class}) TransportUnitTypeVO transportUnitType

The TransportUnitType of the TransportUnit.

weight

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

Weight of the TransportUnit.

Class org.openwms.common.transport.api.UnitErrorVO

class UnitErrorVO extends Object implements Serializable

Serialized Fields

errorNo

String errorNo

Error number.

errorText

String errorText

Error message text.

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

LocalDateTime messageOccurred

messageText

@NotEmpty 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

LocalDateTime 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={Request.class,Remove.class}) String pKey

The persistent key of 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

Some arbitrary compatibility information.

height

int height

The defined height.

length

int length

The defined length.

payload

BigDecimal payload

The defined effective weight.

type

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

The unique type.

weightMax

BigDecimal weightMax

The defined maximum weight.

weightTare

BigDecimal weightTare

The defined tare weight.

width

int width

The defined width.

Package org.openwms.common.transport.barcode

Class org.openwms.common.transport.barcode.Barcode

class Barcode extends Object implements Serializable

Serialized Fields

value

String value

'Identifier' of the Barcode.

Note:It is not guaranteed that this field must be unique.

Class org.openwms.common.transport.barcode.NextBarcode

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

Serialized Fields

currentBarcode

String currentBarcode

Last given Barcode.

name

String name

Name of the Account.

Package org.openwms.common.transport.events

Class org.openwms.common.transport.events.TransportUnitEvent

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

Serialized Fields

actualLocation

Location actualLocation

previousLocation

Location previousLocation

type

TransportUnitEvent.TransportUnitEventType type

Class org.openwms.common.transport.events.TransportUnitTypeEvent

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

Serialized Fields

type

TransportUnitTypeEvent.TransportUnitTypeEventType type

Package org.openwms.common.transport.reservation

Class org.openwms.common.transport.reservation.SplitMO

class SplitMO extends Object implements Serializable

Serialized Fields

reservationId

String reservationId

shippingOrderPositionPKey

String shippingOrderPositionPKey

splitNo

int splitNo

Class org.openwms.common.transport.reservation.TransportUnitReservation

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

Serialized Fields

reservedAt

ZonedDateTime reservedAt

reservedBy

String reservedBy

An arbitrary field to store User, PickOrderPositionSplit etc.

transportUnit

TransportUnit transportUnit

The TransportUnit instance, the Reservation belongs to.

Package org.openwms.common.transport.spi

Exception Class org.openwms.common.transport.spi.NotApprovedException

class NotApprovedException extends Exception implements Serializable