Class OfferSummary

    • Method Detail

      • name

        public final String name()

        The name of the offer.

        Returns:
        The name of the offer.
      • productId

        public final String productId()

        The product ID of the offer.

        Returns:
        The product ID of the offer.
      • releaseDate

        public final String releaseDate()

        The release date of the offer.

        Returns:
        The release date of the offer.
      • availabilityEndDate

        public final String availabilityEndDate()

        The availability end date of the offer.

        Returns:
        The availability end date of the offer.
      • hasBuyerAccounts

        public final boolean hasBuyerAccounts()
        For responses, this returns true if the service returned a value for the BuyerAccounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • buyerAccounts

        public final List<String> buyerAccounts()

        The buyer accounts in the offer.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBuyerAccounts() method.

        Returns:
        The buyer accounts in the offer.
      • targeting

        public final List<OfferTargetingString> targeting()

        The targeting in the offer.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargeting() method.

        Returns:
        The targeting in the offer.
      • hasTargeting

        public final boolean hasTargeting()
        For responses, this returns true if the service returned a value for the Targeting property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • targetingAsStrings

        public final List<String> targetingAsStrings()

        The targeting in the offer.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargeting() method.

        Returns:
        The targeting in the offer.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)