Package com.commercetools.api.models.cart

Interface ItemShippingDetails

public interface ItemShippingDetails
ItemShippingDetails
Example to create an instance using the builder pattern 

     ItemShippingDetails itemShippingDetails = ItemShippingDetails.builder()
             .plusTargets(targetsBuilder -> targetsBuilder)
             .valid(true)
             .build()

  • Method Details

    • getTargets

      @NotNull @Valid @NotNull @Valid List<ItemShippingTarget> getTargets()

      Holds information on the quantity of Line Items or Custom Line Items and the address it is shipped.

      Returns:
      targets

    • getValid

      @NotNull @NotNull Boolean getValid()
      • true if the quantity of Line Items or Custom Line Items is equal to the sum of sub-quantities defined in targets.
      • false if the quantity of Line Items or Custom Line Items is not equal to the sum of sub-quantities defined in targets. Ordering a Cart when the value is false returns an InvalidItemShippingDetails error.
      Returns:
      valid

    • setTargets

      void setTargets(ItemShippingTarget... targets)

      Holds information on the quantity of Line Items or Custom Line Items and the address it is shipped.

      Parameters:
      targets - values to be set

    • setTargets

      void setTargets(List<ItemShippingTarget> targets)

      Holds information on the quantity of Line Items or Custom Line Items and the address it is shipped.

      Parameters:
      targets - values to be set

    • setValid

      void setValid(Boolean valid)
      • true if the quantity of Line Items or Custom Line Items is equal to the sum of sub-quantities defined in targets.
      • false if the quantity of Line Items or Custom Line Items is not equal to the sum of sub-quantities defined in targets. Ordering a Cart when the value is false returns an InvalidItemShippingDetails error.
      Parameters:
      valid - value to be set

    • of

      static ItemShippingDetails of()
      factory method
      Returns:
      instance of ItemShippingDetails

    • of

      static ItemShippingDetails of(ItemShippingDetails template)
      factory method to create a shallow copy ItemShippingDetails
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static ItemShippingDetails deepCopy(@Nullable ItemShippingDetails template)
      factory method to create a deep copy of ItemShippingDetails
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ItemShippingDetailsBuilder builder()
      builder factory method for ItemShippingDetails
      Returns:
      builder

    • builder

      static ItemShippingDetailsBuilder builder(ItemShippingDetails template)
      create builder for ItemShippingDetails instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withItemShippingDetails

      default <T> T withItemShippingDetails(Function<ItemShippingDetails,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ItemShippingDetails> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference