Class MessageReference


  • public class MessageReference
    extends Object
    Identification of a previous POI transaction. To abort a transaction in progress or to request the status of a transaction from which no response has been received. It identifies the message header of the message request to abort or request the status.
    • Constructor Detail

      • MessageReference

        public MessageReference()
    • Method Detail

      • messageCategory

        public MessageReference messageCategory​(MessageCategory messageCategory)
        messageCategory
        Parameters:
        messageCategory -
        Returns:
        the current MessageReference instance, allowing for method chaining
      • getMessageCategory

        public MessageCategory getMessageCategory()
        Get messageCategory
        Returns:
        messageCategory
      • setMessageCategory

        public void setMessageCategory​(MessageCategory messageCategory)
        messageCategory
        Parameters:
        messageCategory -
      • serviceID

        public MessageReference serviceID​(String serviceID)
        Identification of a message pair, which processes a transaction.
        Parameters:
        serviceID - Identification of a message pair, which processes a transaction.
        Returns:
        the current MessageReference instance, allowing for method chaining
      • getServiceID

        public String getServiceID()
        Identification of a message pair, which processes a transaction.
        Returns:
        serviceID Identification of a message pair, which processes a transaction.
      • setServiceID

        public void setServiceID​(String serviceID)
        Identification of a message pair, which processes a transaction.
        Parameters:
        serviceID - Identification of a message pair, which processes a transaction.
      • deviceID

        public MessageReference deviceID​(String deviceID)
        Identification of a device message pair.
        Parameters:
        deviceID - Identification of a device message pair.
        Returns:
        the current MessageReference instance, allowing for method chaining
      • getDeviceID

        public String getDeviceID()
        Identification of a device message pair.
        Returns:
        deviceID Identification of a device message pair.
      • setDeviceID

        public void setDeviceID​(String deviceID)
        Identification of a device message pair.
        Parameters:
        deviceID - Identification of a device message pair.
      • saleID

        public MessageReference saleID​(String saleID)
        Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. default MessageHeader.SaleID.
        Parameters:
        saleID - Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. default MessageHeader.SaleID.
        Returns:
        the current MessageReference instance, allowing for method chaining
      • getSaleID

        public String getSaleID()
        Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. default MessageHeader.SaleID.
        Returns:
        saleID Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. default MessageHeader.SaleID.
      • setSaleID

        public void setSaleID​(String saleID)
        Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. default MessageHeader.SaleID.
        Parameters:
        saleID - Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. default MessageHeader.SaleID.
      • POIID

        public MessageReference POIID​(String POIID)
        Identification of a POI System or a POI Terminal for the Sale to POI protocol. Default `MessageHeader.POIID`.
        Parameters:
        POIID - Identification of a POI System or a POI Terminal for the Sale to POI protocol. Default `MessageHeader.POIID`.
        Returns:
        the current MessageReference instance, allowing for method chaining
      • getPOIID

        public String getPOIID()
        Identification of a POI System or a POI Terminal for the Sale to POI protocol. Default `MessageHeader.POIID`.
        Returns:
        POIID Identification of a POI System or a POI Terminal for the Sale to POI protocol. Default `MessageHeader.POIID`.
      • setPOIID

        public void setPOIID​(String POIID)
        Identification of a POI System or a POI Terminal for the Sale to POI protocol. Default `MessageHeader.POIID`.
        Parameters:
        POIID - Identification of a POI System or a POI Terminal for the Sale to POI protocol. Default `MessageHeader.POIID`.
      • includeNullValues

        public MessageReference includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this MessageReference object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static MessageReference fromJson​(String jsonString)
                                         throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of MessageReference given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of MessageReference
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to MessageReference
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of MessageReference to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException