Package org.openwms.common.comm.osip

Class Payload

java.lang.Object
org.openwms.common.comm.osip.Payload
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ErrorMessage, LocationUpdateMessage, RequestMessage, ResponseMessage, SystemUpdateMessage, TimesyncRequest, TimesyncResponse, UpdateMessage
public abstract class Payload extends Object implements Serializable
A Payload is the abstract superclass of all messages sent to subsystems like PLC or ERP.
Author:
Heiko Scherrer
See Also:

  • Field Details

  • Constructor Details

    • Payload

      public Payload()

  • Method Details

    • exists

      public static boolean exists(String str)
      Checks if the given str starts with an '*'. An optional telegram value contains '*' only.
      Parameters:
      str - to check
      Returns:
      true if set

    • getHeader

      public ResponseHeader getHeader()

    • setHeader

      protected void setHeader(ResponseHeader header)

    • getMessageIdentifier

      public abstract String getMessageIdentifier()
      Subclasses have to return an unique, case-sensitive message identifier.
      Returns:
      The message TYPE field (see OSIP specification)

    • isWithoutReply

      public abstract boolean isWithoutReply()
      Does this type of message needs to be replied to?
      Returns:
      true no reply needed, otherwise false

    • getErrorCode

      public String getErrorCode()
      Get the errorCode.
      Returns:
      the errorCode.

    • hasErrorCode

      public boolean hasErrorCode()
      Checks wether the errorCode is not null.
      Returns:
      true if errorCode is set, otherwise false

    • setErrorCode

      public void setErrorCode(String errorCode)
      Set the errorCode.
      Parameters:
      errorCode - The errorCode to set.

    • getCreated

      public Date getCreated()
      Get the created.
      Returns:
      the created.

    • setCreated

      protected void setCreated(Date created)
      Set the created.
      Parameters:
      created - The created to set.

    • equals

      public boolean equals(Object o)
      Use all fields.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Use all fields.
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Use all fields.
      Overrides:
      toString in class Object