Package com.commercetools.api.models.order

Interface OrderSetReturnPaymentStateAction

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

To set a ReturnPaymentState, the Order returnInfo must have at least one ReturnItem.

Example to create an instance using the builder pattern 

     OrderSetReturnPaymentStateAction orderSetReturnPaymentStateAction = OrderSetReturnPaymentStateAction.builder()
             .paymentState(ReturnPaymentState.NON_REFUNDABLE)
             .build()

  • Field Details

    • SET_RETURN_PAYMENT_STATE

      static final String SET_RETURN_PAYMENT_STATE
      discriminator value for OrderSetReturnPaymentStateAction
      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

    • getPaymentState

      @NotNull @NotNull ReturnPaymentState getPaymentState()

      New Payment status of the ReturnItem.

      Returns:
      paymentState

    • 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

    • setPaymentState

      void setPaymentState(ReturnPaymentState paymentState)

      New Payment status of the ReturnItem.

      Parameters:
      paymentState - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderSetReturnPaymentStateActionBuilder builder()
      builder factory method for OrderSetReturnPaymentStateAction
      Returns:
      builder

    • builder

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

    • withOrderSetReturnPaymentStateAction

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