Package com.commercetools.api.models.order_edit

Interface StagedOrderSetDeliveryItemsAction

All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction
public interface StagedOrderSetDeliveryItemsAction extends StagedOrderUpdateAction

Produces the Delivery Items Updated Message.

Example to create an instance using the builder pattern 

     StagedOrderSetDeliveryItemsAction stagedOrderSetDeliveryItemsAction = StagedOrderSetDeliveryItemsAction.builder()
             .plusItems(itemsBuilder -> itemsBuilder)
             .build()

  • Field Details

    • SET_DELIVERY_ITEMS

      static final String SET_DELIVERY_ITEMS
      discriminator value for StagedOrderSetDeliveryItemsAction
      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 StagedOrderSetDeliveryItemsAction of()
      factory method
      Returns:
      instance of StagedOrderSetDeliveryItemsAction

    • of

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

    • deepCopy

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

    • builder

      static StagedOrderSetDeliveryItemsActionBuilder builder()
      builder factory method for StagedOrderSetDeliveryItemsAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetDeliveryItemsAction

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