Package com.commercetools.api.models.order

Interface OrderSetDeliveryItemsAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>
public interface OrderSetDeliveryItemsAction extends OrderUpdateAction

Produces the Delivery Items Updated Message.

Example to create an instance using the builder pattern 

     OrderSetDeliveryItemsAction orderSetDeliveryItemsAction = OrderSetDeliveryItemsAction.builder()
             .plusItems(itemsBuilder -> itemsBuilder)
             .build()

  • Field Details

    • SET_DELIVERY_ITEMS

      static final String SET_DELIVERY_ITEMS
      discriminator value for OrderSetDeliveryItemsAction
      See Also:

  • Method Details

    • getDeliveryId

      String getDeliveryId()

      id of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Returns:
      deliveryId

    • getDeliveryKey

      String getDeliveryKey()

      key of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Returns:
      deliveryKey

    • getItems

      @NotNull @Valid @NotNull @Valid List<DeliveryItem> getItems()

      Value to set. If empty, any existing value is removed.

      Returns:
      items

    • setDeliveryId

      void setDeliveryId(String deliveryId)

      id of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Parameters:
      deliveryId - value to be set

    • setDeliveryKey

      void setDeliveryKey(String deliveryKey)

      key of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Parameters:
      deliveryKey - value to be set

    • setItems

      void setItems(DeliveryItem... items)

      Value to set. If empty, any existing value is removed.

      Parameters:
      items - values to be set

    • setItems

      void setItems(List<DeliveryItem> items)

      Value to set. If empty, any existing value is removed.

      Parameters:
      items - values to be set

    • of

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

    • of

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

    • copyDeep

      OrderSetDeliveryItemsAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

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

    • builder

      static OrderSetDeliveryItemsActionBuilder builder()
      builder factory method for OrderSetDeliveryItemsAction
      Returns:
      builder

    • builder

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

    • withOrderSetDeliveryItemsAction

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