Package com.commercetools.api.models.order

Interface OrderSetDeliveryAddressAction

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

Produces the DeliveryAddressSet Message.

Example to create an instance using the builder pattern 

     OrderSetDeliveryAddressAction orderSetDeliveryAddressAction = OrderSetDeliveryAddressAction.builder()
             .build()

  • Field Details

    • SET_DELIVERY_ADDRESS

      static final String SET_DELIVERY_ADDRESS
      discriminator value for OrderSetDeliveryAddressAction
      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

    • getAddress

      @Valid @Valid BaseAddress getAddress()

      Value to set. It replaces the entire address, including Custom Fields if custom is not included. To preserve Custom Fields, include the custom object in the request.

      If omitted, any existing value is removed.

      Returns:
      address

    • 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

    • setAddress

      void setAddress(BaseAddress address)

      Value to set. It replaces the entire address, including Custom Fields if custom is not included. To preserve Custom Fields, include the custom object in the request.

      If omitted, any existing value is removed.

      Parameters:
      address - value to be set

    • of

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

    • of

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

    • copyDeep

      OrderSetDeliveryAddressAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

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

    • builder

      static OrderSetDeliveryAddressActionBuilder builder()
      builder factory method for OrderSetDeliveryAddressAction
      Returns:
      builder

    • builder

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

    • withOrderSetDeliveryAddressAction

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

    • ofUnset

      static OrderSetDeliveryAddressAction ofUnset(String deliveryId)

    • typeReference

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