Package com.commercetools.api.models.order

Interface OrderSetReturnItemCustomTypeAction

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

     OrderSetReturnItemCustomTypeAction orderSetReturnItemCustomTypeAction = OrderSetReturnItemCustomTypeAction.builder()
             .build()

  • Field Details

    • SET_RETURN_ITEM_CUSTOM_TYPE

      static final String SET_RETURN_ITEM_CUSTOM_TYPE
      discriminator value for OrderSetReturnItemCustomTypeAction
      See Also:

  • Method Details

    • getReturnItemId

      String getReturnItemId()

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

      Returns:
      returnItemId

    • getReturnItemKey

      String getReturnItemKey()

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

      Returns:
      returnItemKey

    • getType

      @Valid @Valid TypeResourceIdentifier getType()

      Defines the Type that extends the Return Item with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Return Item.

      Returns:
      type

    • getFields

      @Valid @Valid FieldContainer getFields()

      Sets the Custom Fields fields for the Return Item.

      Returns:
      fields

    • setReturnItemId

      void setReturnItemId(String returnItemId)

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

      Parameters:
      returnItemId - value to be set

    • setReturnItemKey

      void setReturnItemKey(String returnItemKey)

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

      Parameters:
      returnItemKey - value to be set

    • setType

      void setType(TypeResourceIdentifier type)

      Defines the Type that extends the Return Item with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Return Item.

      Parameters:
      type - value to be set

    • setFields

      void setFields(FieldContainer fields)

      Sets the Custom Fields fields for the Return Item.

      Parameters:
      fields - value to be set

    • of

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

    • of

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

    • copyDeep

      OrderSetReturnItemCustomTypeAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

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

    • builder

      static OrderSetReturnItemCustomTypeActionBuilder builder()
      builder factory method for OrderSetReturnItemCustomTypeAction
      Returns:
      builder

    • builder

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

    • withOrderSetReturnItemCustomTypeAction

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