Class StoredValueData


  • public class StoredValueData
    extends Object
    It contains: - the identification of the stored value accounts or the stored value cards, if provided by the Sale System, and - the associated products sold by the Sale System. Data related to the stored value card.
    • Constructor Detail

      • StoredValueData

        public StoredValueData()
    • Method Detail

      • storedValueProvider

        public StoredValueData storedValueProvider​(String storedValueProvider)
        Identification of the provider of the stored value account load/reload. If more than one provider to manage on the POI, and StoredValueAccountID absent.
        Parameters:
        storedValueProvider - Identification of the provider of the stored value account load/reload. If more than one provider to manage on the POI, and StoredValueAccountID absent.
        Returns:
        the current StoredValueData instance, allowing for method chaining
      • getStoredValueProvider

        public String getStoredValueProvider()
        Identification of the provider of the stored value account load/reload. If more than one provider to manage on the POI, and StoredValueAccountID absent.
        Returns:
        storedValueProvider Identification of the provider of the stored value account load/reload. If more than one provider to manage on the POI, and StoredValueAccountID absent.
      • setStoredValueProvider

        public void setStoredValueProvider​(String storedValueProvider)
        Identification of the provider of the stored value account load/reload. If more than one provider to manage on the POI, and StoredValueAccountID absent.
        Parameters:
        storedValueProvider - Identification of the provider of the stored value account load/reload. If more than one provider to manage on the POI, and StoredValueAccountID absent.
      • storedValueTransactionType

        public StoredValueData storedValueTransactionType​(StoredValueTransactionType storedValueTransactionType)
        storedValueTransactionType
        Parameters:
        storedValueTransactionType -
        Returns:
        the current StoredValueData instance, allowing for method chaining
      • getStoredValueTransactionType

        public StoredValueTransactionType getStoredValueTransactionType()
        Get storedValueTransactionType
        Returns:
        storedValueTransactionType
      • setStoredValueTransactionType

        public void setStoredValueTransactionType​(StoredValueTransactionType storedValueTransactionType)
        storedValueTransactionType
        Parameters:
        storedValueTransactionType -
      • storedValueAccountID

        public StoredValueData storedValueAccountID​(StoredValueAccountID storedValueAccountID)
        storedValueAccountID
        Parameters:
        storedValueAccountID -
        Returns:
        the current StoredValueData instance, allowing for method chaining
      • getStoredValueAccountID

        public StoredValueAccountID getStoredValueAccountID()
        Get storedValueAccountID
        Returns:
        storedValueAccountID
      • setStoredValueAccountID

        public void setStoredValueAccountID​(StoredValueAccountID storedValueAccountID)
        storedValueAccountID
        Parameters:
        storedValueAccountID -
      • originalPOITransaction

        public StoredValueData originalPOITransaction​(OriginalPOITransaction originalPOITransaction)
        originalPOITransaction
        Parameters:
        originalPOITransaction -
        Returns:
        the current StoredValueData instance, allowing for method chaining
      • getOriginalPOITransaction

        public OriginalPOITransaction getOriginalPOITransaction()
        Get originalPOITransaction
        Returns:
        originalPOITransaction
      • setOriginalPOITransaction

        public void setOriginalPOITransaction​(OriginalPOITransaction originalPOITransaction)
        originalPOITransaction
        Parameters:
        originalPOITransaction -
      • productCode

        public StoredValueData productCode​(Integer productCode)
        Product code of item purchased with the transaction.
        Parameters:
        productCode - Product code of item purchased with the transaction.
        Returns:
        the current StoredValueData instance, allowing for method chaining
      • getProductCode

        public Integer getProductCode()
        Product code of item purchased with the transaction. minimum: 1 maximum: 20
        Returns:
        productCode Product code of item purchased with the transaction.
      • setProductCode

        public void setProductCode​(Integer productCode)
        Product code of item purchased with the transaction.
        Parameters:
        productCode - Product code of item purchased with the transaction.
      • eanUpc

        public StoredValueData eanUpc​(Integer eanUpc)
        Standard product code of item purchased with the transaction.
        Parameters:
        eanUpc - Standard product code of item purchased with the transaction.
        Returns:
        the current StoredValueData instance, allowing for method chaining
      • getEanUpc

        public Integer getEanUpc()
        Standard product code of item purchased with the transaction.
        Returns:
        eanUpc Standard product code of item purchased with the transaction.
      • setEanUpc

        public void setEanUpc​(Integer eanUpc)
        Standard product code of item purchased with the transaction.
        Parameters:
        eanUpc - Standard product code of item purchased with the transaction.
      • itemAmount

        public StoredValueData itemAmount​(BigDecimal itemAmount)
        Total amount of the item line.
        Parameters:
        itemAmount - Total amount of the item line.
        Returns:
        the current StoredValueData instance, allowing for method chaining
      • getItemAmount

        public BigDecimal getItemAmount()
        Total amount of the item line. minimum: 0.0 maximum: 99999999.999999
        Returns:
        itemAmount Total amount of the item line.
      • setItemAmount

        public void setItemAmount​(BigDecimal itemAmount)
        Total amount of the item line.
        Parameters:
        itemAmount - Total amount of the item line.
      • currency

        public StoredValueData currency​(String currency)
        Currency of a monetary amount.
        Parameters:
        currency - Currency of a monetary amount.
        Returns:
        the current StoredValueData instance, allowing for method chaining
      • getCurrency

        public String getCurrency()
        Currency of a monetary amount.
        Returns:
        currency Currency of a monetary amount.
      • setCurrency

        public void setCurrency​(String currency)
        Currency of a monetary amount.
        Parameters:
        currency - Currency of a monetary amount.
      • includeNullValues

        public StoredValueData 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 StoredValueData 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 StoredValueData fromJson​(String jsonString)
                                        throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of StoredValueData given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of StoredValueData
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to StoredValueData
      • toJson

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