Package com.commercetools.api.models.shopping_list

Interface TextLineItemDraft

All Superinterfaces:
CustomizableDraft<TextLineItemDraft>, io.vrap.rmf.base.client.Draft<TextLineItemDraft>
All Known Implementing Classes:
TextLineItemDraftImpl
public interface TextLineItemDraft extends CustomizableDraft<TextLineItemDraft>, io.vrap.rmf.base.client.Draft<TextLineItemDraft>
TextLineItemDraft
Example to create an instance using the builder pattern 

     TextLineItemDraft textLineItemDraft = TextLineItemDraft.builder()
             .name(nameBuilder -> nameBuilder)
             .build()

  • Method Details

    • getKey

      String getKey()

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

      Returns:
      key

    • getAddedAt

      ZonedDateTime getAddedAt()

      Date and time the TextLineItem 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 for the TextLineItem.

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

    • getDescription

      @Valid @Valid LocalizedString getDescription()

      Description of the TextLineItem.

      Returns:
      description

    • getName

      @NotNull @Valid @NotNull @Valid LocalizedString getName()

      Name of the TextLineItem.

      Returns:
      name

    • getQuantity

      Long getQuantity()

      Number of entries in the TextLineItem.

      Returns:
      quantity

    • setKey

      void setKey(String key)

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

      Parameters:
      key - value to be set

    • setAddedAt

      void setAddedAt(ZonedDateTime addedAt)

      Date and time the TextLineItem 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 for the TextLineItem.

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

    • setDescription

      void setDescription(LocalizedString description)

      Description of the TextLineItem.

      Parameters:
      description - value to be set

    • setName

      void setName(LocalizedString name)

      Name of the TextLineItem.

      Parameters:
      name - value to be set

    • setQuantity

      void setQuantity(Long quantity)

      Number of entries in the TextLineItem.

      Parameters:
      quantity - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static TextLineItemDraftBuilder builder()
      builder factory method for TextLineItemDraft
      Returns:
      builder

    • builder

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

    • withTextLineItemDraft

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