Package com.commercetools.api.models.order

Class OrderSetReturnItemCustomFieldActionBuilder

java.lang.Object
com.commercetools.api.models.order.OrderSetReturnItemCustomFieldActionBuilder
All Implemented Interfaces:
Builder<OrderSetReturnItemCustomFieldAction>
public class OrderSetReturnItemCustomFieldActionBuilder extends Object implements Builder<OrderSetReturnItemCustomFieldAction>
OrderSetReturnItemCustomFieldActionBuilder
Example to create an instance using the builder pattern 

     OrderSetReturnItemCustomFieldAction orderSetReturnItemCustomFieldAction = OrderSetReturnItemCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Constructor Details

    • OrderSetReturnItemCustomFieldActionBuilder

      public OrderSetReturnItemCustomFieldActionBuilder()

  • Method Details

    • returnItemId

      public OrderSetReturnItemCustomFieldActionBuilder returnItemId(@Nullable String returnItemId)

      id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Parameters:
      returnItemId - value to be set
      Returns:
      Builder

    • returnItemKey

      public OrderSetReturnItemCustomFieldActionBuilder returnItemKey(@Nullable String returnItemKey)

      key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Parameters:
      returnItemKey - value to be set
      Returns:
      Builder

    • name

      public OrderSetReturnItemCustomFieldActionBuilder name(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set
      Returns:
      Builder

    • value

      public OrderSetReturnItemCustomFieldActionBuilder value(@Nullable 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
      Returns:
      Builder

    • getReturnItemId

      @Nullable public String getReturnItemId()

      id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Returns:
      returnItemId

    • getReturnItemKey

      @Nullable public String getReturnItemKey()

      key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Returns:
      returnItemKey

    • getName

      public String getName()

      Name of the Custom Field.

      Returns:
      name

    • getValue

      @Nullable public 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

    • build

      public OrderSetReturnItemCustomFieldAction build()
      builds OrderSetReturnItemCustomFieldAction with checking for non-null required values
      Specified by:
      build in interface Builder<OrderSetReturnItemCustomFieldAction>
      Returns:
      OrderSetReturnItemCustomFieldAction

    • buildUnchecked

      public OrderSetReturnItemCustomFieldAction buildUnchecked()
      builds OrderSetReturnItemCustomFieldAction without checking for non-null required values
      Returns:
      OrderSetReturnItemCustomFieldAction

    • of

      public static OrderSetReturnItemCustomFieldActionBuilder of()
      factory method for an instance of OrderSetReturnItemCustomFieldActionBuilder
      Returns:
      builder

    • of

      public static OrderSetReturnItemCustomFieldActionBuilder of(OrderSetReturnItemCustomFieldAction template)
      create builder for OrderSetReturnItemCustomFieldAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder