Package com.commercetools.api.models.shopping_list

Interface ShoppingListLineItemDraft

All Superinterfaces:
CustomizableDraft<ShoppingListLineItemDraft>, Draft<ShoppingListLineItemDraft>
public interface ShoppingListLineItemDraft extends CustomizableDraft<ShoppingListLineItemDraft>, Draft<ShoppingListLineItemDraft>

The ProductVariant to be included in the ShoppingListLineItem must be specified using the productID and variantID, or by the sku.

Example to create an instance using the builder pattern 

     ShoppingListLineItemDraft shoppingListLineItemDraft = ShoppingListLineItemDraft.builder()
             .build()

  • Method Details

    • getKey

      String getKey()

      User-defined identifier of the ShoppingListLineItem. Must be unique per ShoppingList.

      Returns:
      key

    • getProductId

      String getProductId()

      Unique identifier of a Product.

      Returns:
      productId

    • getVariantId

      Long getVariantId()

      id of the ProductVariant. If not set, the ShoppingListLineItem refers to the Master Variant.

      Returns:
      variantId

    • getSku

      String getSku()

      sku of the ProductVariant.

      Returns:
      sku

    • getAddedAt

      ZonedDateTime getAddedAt()

      Date and time the ShoppingListLineItem is added to the ShoppingList. If not set, the current date and time (UTC) is used.

      Returns:
      addedAt

    • getCustom

      @Valid @Valid CustomFieldsDraft getCustom()

      Custom Fields of the ShoppingListLineItem.

      Specified by:
      getCustom in interface CustomizableDraft<ShoppingListLineItemDraft>
      Returns:
      custom

    • getQuantity

      Long getQuantity()

      Number of Products in the ShoppingListLineItem.

      Returns:
      quantity

    • setKey

      void setKey(String key)

      User-defined identifier of the ShoppingListLineItem. Must be unique per ShoppingList.

      Parameters:
      key - value to be set

    • setProductId

      void setProductId(String productId)

      Unique identifier of a Product.

      Parameters:
      productId - value to be set

    • setVariantId

      void setVariantId(Long variantId)

      id of the ProductVariant. If not set, the ShoppingListLineItem refers to the Master Variant.

      Parameters:
      variantId - value to be set

    • setSku

      void setSku(String sku)

      sku of the ProductVariant.

      Parameters:
      sku - value to be set

    • setAddedAt

      void setAddedAt(ZonedDateTime addedAt)

      Date and time the ShoppingListLineItem is added to the ShoppingList. If not set, the current date and time (UTC) is used.

      Parameters:
      addedAt - value to be set

    • setCustom

      void setCustom(CustomFieldsDraft custom)

      Custom Fields of the ShoppingListLineItem.

      Specified by:
      setCustom in interface CustomizableDraft<ShoppingListLineItemDraft>
      Parameters:
      custom - value to be set

    • setQuantity

      void setQuantity(Long quantity)

      Number of Products in the ShoppingListLineItem.

      Parameters:
      quantity - value to be set

    • of

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

    • of

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

    • copyDeep

      ShoppingListLineItemDraft copyDeep()

    • deepCopy

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

    • builder

      static ShoppingListLineItemDraftBuilder builder()
      builder factory method for ShoppingListLineItemDraft
      Returns:
      builder

    • builder

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

    • withShoppingListLineItemDraft

      default <T> T withShoppingListLineItemDraft(Function<ShoppingListLineItemDraft,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<ShoppingListLineItemDraft> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference