Package com.commercetools.api.models.order_edit

Interface StagedOrderSetDeliveryCustomFieldAction

All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction
public interface StagedOrderSetDeliveryCustomFieldAction extends StagedOrderUpdateAction
StagedOrderSetDeliveryCustomFieldAction
Example to create an instance using the builder pattern 

     StagedOrderSetDeliveryCustomFieldAction stagedOrderSetDeliveryCustomFieldAction = StagedOrderSetDeliveryCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Field Details

    • SET_DELIVERY_CUSTOM_FIELD

      static final String SET_DELIVERY_CUSTOM_FIELD
      discriminator value for StagedOrderSetDeliveryCustomFieldAction
      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

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field.

      Returns:
      name

    • getValue

      Object getValue()

      If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Returns:
      value

    • 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

    • setName

      void setName(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set

    • setValue

      void setValue(Object value)

      If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Parameters:
      value - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static StagedOrderSetDeliveryCustomFieldActionBuilder builder()
      builder factory method for StagedOrderSetDeliveryCustomFieldAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetDeliveryCustomFieldAction

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

    • ofUnset

      static StagedOrderSetDeliveryCustomFieldAction ofUnset(String name, String deliveryId)

    • typeReference

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