Package org.openwms.common.location.api

Class LocationGroupVO

java.lang.Object
org.springframework.hateoas.RepresentationModel<LocationGroupVO>
org.openwms.common.location.api.LocationGroupVO
All Implemented Interfaces:
Serializable, TargetVO
public class LocationGroupVO extends org.springframework.hateoas.RepresentationModel<LocationGroupVO> implements TargetVO, Serializable
A LocationGroupVO represents a LocationGroup.
Author:
Heiko Scherrer
See Also:

  • Field Details

    • pKey

      private String pKey
      The persistent technical key of the LocationGroup.

    • name

      @NotBlank private @NotBlank String name
      Unique identifier of the LocationGroup.

    • accountId

      private String accountId
      The LocationGroup might be assigned to an Account.

    • description

      private String description
      Description of the LocationGroup.

    • groupType

      private String groupType
      A type can be assigned to a LocationGroup.

    • parent

      private String parent
      Parent LocationGroup.

    • operationMode

      @NotBlank(groups=Create.class) private @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.

    • groupStateIn

      private LocationGroupState groupStateIn
      Infeed state, controlled by the subsystem only.

    • groupStateOut

      private LocationGroupState groupStateOut
      Outfeed state.

    • children

      private List<LocationGroupVO> children
      Child LocationGroups.

    • createDt

      private LocalDateTime createDt
      Timestamp when the LocationGroup has been created.

  • Constructor Details

  • Method Details

    • create

      public static LocationGroupVO create(String name, String operationMode)
      Creates a new LocationGroupVO object with the given name and operation mode.
      Parameters:
      name - The name of the location group.
      operationMode - The operation mode of the location group.
      Returns:
      The created LocationGroupVO object.

    • streamLocationGroups

      public Stream<LocationGroupVO> streamLocationGroups()

    • hasParent

      public boolean hasParent()
      Check whether the LocationGroup has a parent.
      Returns:
      true if it has a parent, otherwise false

    • isInfeedBlocked

      public boolean isInfeedBlocked()
      Checks whether the LocationGroup is blocked for infeed.
      Returns:
      true if blocked, otherwise false

    • isIncomingActive

      public boolean isIncomingActive()
      Checks whether the LocationGroup is available for infeed.
      Returns:
      true if available, otherwise false

    • setIncomingActive

      public void setIncomingActive(boolean incomingActive)
      Set the infeed mode.
      Parameters:
      incomingActive - true if available for infeed otherwise false

    • setGroupStateIn

      public void setGroupStateIn(LocationGroupState groupStateIn)

    • isOutgoingActive

      public boolean isOutgoingActive()
      Checks whether the LocationGroup is available for outfeed.
      Returns:
      true if available, otherwise false

    • setOutgoingActive

      public void setOutgoingActive(boolean outgoingActive)
      Set the outfeed mode.
      Parameters:
      outgoingActive - true if available for outfeed otherwise false

    • setGroupStateOut

      public void setGroupStateOut(LocationGroupState groupStateOut)

    • getOperationMode

      public String getOperationMode()

    • setOperationMode

      public void setOperationMode(String operationMode)

    • getGroupStateIn

      public LocationGroupState getGroupStateIn()

    • getGroupStateOut

      public LocationGroupState getGroupStateOut()

    • 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)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getAccountId

      public String getAccountId()

    • setAccountId

      public void setAccountId(String accountId)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getGroupType

      public String getGroupType()

    • setGroupType

      public void setGroupType(String groupType)

    • getParent

      public String getParent()

    • setParent

      public void setParent(String parent)

    • getChildren

      public List<LocationGroupVO> getChildren()

    • addChild

      public LocationGroupVO addChild(LocationGroupVO child)

    • setChildren

      public void setChildren(List<LocationGroupVO> children)

    • getCreateDt

      public LocalDateTime getCreateDt()

    • setCreateDt

      public void setCreateDt(LocalDateTime createDt)

    • asString

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

    • equals

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

    • hashCode

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

    • toString

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

    • allFieldsToString

      public String allFieldsToString()
      Returns a string representation of the LocationGroupVO object, including all its fields. Fields are concatenated using a delimiter ", ".
      Returns:
      A string representation of the LocationGroupVO object.