Package org.openwms.common.location.api

Class LocationVO

java.lang.Object
org.springframework.hateoas.RepresentationModel<LocationVO>
org.ameba.http.AbstractBase<LocationVO>
org.openwms.common.location.api.LocationVO
All Implemented Interfaces:
Serializable, TargetVO
public class LocationVO extends org.ameba.http.AbstractBase<LocationVO> implements TargetVO, Serializable
A LocationVO represents a physical or virtual place in a warehouse. Could be something like a storage location in the stock or a conveyor location. Even error locations can be represented with the LocationVO. Multiple locations with same characteristics are grouped in LocationGroupVOs.
Author:
Heiko Scherrer
See Also:

  • Field Details

    • MEDIA_TYPE

      public static final String MEDIA_TYPE
      HTTP media type representation.
      See Also:

    • MEDIA_TYPE_OPT

      public static final String MEDIA_TYPE_OPT
      HTTP media type representation.
      See Also:

    • pKey

      private String pKey
      The persistent technical key of the Location.

    • locationId

      @NotBlank private @NotBlank String locationId
      Unique natural key.

    • accountId

      private String accountId
      The ID of the Account, the Location is assigned to.

    • plcCode

      @NotBlank(groups=Create.class) private @NotBlank(groups=Create.class) String plcCode
      PLC code of the Location.

    • erpCode

      @NotBlank(groups=Create.class) private @NotBlank(groups=Create.class) String erpCode
      ERP code of the Location.

    • sortOrder

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

    • stockZone

      private String stockZone
      Might be assigned to a particular zone in stock.

    • incomingActive

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

    • outgoingActive

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

    • plcState

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

    • type

      @NotBlank(groups=Create.class) private @NotBlank(groups=Create.class) String type
      The name of the LocationType the Location belongs to.

    • locationGroupName

      @NotBlank(groups=Create.class) private @NotBlank(groups=Create.class) String locationGroupName
      The name of LocationGroup the Location belongs to.

    • createDt

      private LocalDateTime createDt
      Timestamp when the Location has been created.

  • Constructor Details

    • LocationVO

      protected LocationVO()

    • LocationVO

      public LocationVO(String locationId)

  • Method Details

    • isInfeedBlocked

      public boolean isInfeedBlocked()
      Checks whether the Location is blocked for incoming goods.
      Returns:
      true if blocked, otherwise false

    • isOutfeedBlocked

      public boolean isOutfeedBlocked()
      Checks whether the Location is blocked for outgoing goods.
      Returns:
      true if blocked, otherwise false

    • getAccountId

      public String getAccountId()

    • setAccountId

      public void setAccountId(String accountId)

    • getLocationGroupName

      public String getLocationGroupName()

    • setLocationGroupName

      public void setLocationGroupName(String locationGroupName)

    • getpKey

      public String getpKey()
      Description copied from interface: TargetVO
      Get the persistent key.
      Specified by:
      getpKey in interface TargetVO
      Returns:
      As String

    • setpKey

      public void setpKey(String pKey)

    • getLocationId

      public String getLocationId()

    • setLocationId

      public void setLocationId(String locationId)

    • getType

      public String getType()

    • setType

      public void setType(String type)

    • getErpCode

      public String getErpCode()

    • setErpCode

      public void setErpCode(String erpCode)

    • getPlcCode

      public String getPlcCode()

    • setPlcCode

      public void setPlcCode(String plcCode)

    • getSortOrder

      public Integer getSortOrder()

    • setSortOrder

      public void setSortOrder(Integer sortOrder)

    • getIncomingActive

      public Boolean getIncomingActive()

    • setIncomingActive

      public void setIncomingActive(Boolean incomingActive)

    • getOutgoingActive

      public Boolean getOutgoingActive()

    • setOutgoingActive

      public void setOutgoingActive(Boolean outgoingActive)

    • getPlcState

      public Integer getPlcState()

    • setPlcState

      public void setPlcState(Integer plcState)

    • getStockZone

      public String getStockZone()

    • setStockZone

      public void setStockZone(String stockZone)

    • getCreateDt

      public LocalDateTime getCreateDt()
      Overrides:
      getCreateDt in class org.ameba.http.AbstractBase<LocationVO>

    • setCreateDt

      public void setCreateDt(LocalDateTime createDt)
      Overrides:
      setCreateDt in class org.ameba.http.AbstractBase<LocationVO>

    • asString

      public String asString()
      Returns the unique business key of the Target.
      Specified by:
      asString in interface TargetVO
      Returns:
      Unique business key

    • toString

      public String toString()
      Only the locationId.
      Overrides:
      toString in class org.springframework.hateoas.RepresentationModel<LocationVO>

    • equals

      public boolean equals(Object o)
      All fields.
      Overrides:
      equals in class org.springframework.hateoas.RepresentationModel<LocationVO>

    • hashCode

      public int hashCode()
      All fields.
      Overrides:
      hashCode in class org.springframework.hateoas.RepresentationModel<LocationVO>