Package com.commercetools.api.models.error

Interface RecurringOrderFailureError

All Superinterfaces:
ErrorObject
public interface RecurringOrderFailureError extends ErrorObject

Returned when a subsequent Order for a Recurring Order could not be processed.

Example to create an instance using the builder pattern 

     RecurringOrderFailureError recurringOrderFailureError = RecurringOrderFailureError.builder()
             .message("{message}")
             .build()

  • Field Details

    • RECURRING_ORDER_FAILURE

      static final String RECURRING_ORDER_FAILURE
      discriminator value for RecurringOrderFailureError
      See Also:

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()
      Description copied from interface: ErrorObject

      Error identifier.

      Specified by:
      getCode in interface ErrorObject
      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      Plain text description of the error.

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • getDetails

      @NotNull @NotNull Object getDetails()

      Details about the error's cause and the entities involved.

      Returns:
      details

    • setMessage

      void setMessage(String message)

      Plain text description of the error.

      Specified by:
      setMessage in interface ErrorObject
      Parameters:
      message - value to be set

    • setDetails

      void setDetails(Object details)

      Details about the error's cause and the entities involved.

      Parameters:
      details - value to be set

    • of

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

    • of

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

    • copyDeep

      RecurringOrderFailureError copyDeep()
      Specified by:
      copyDeep in interface ErrorObject

    • deepCopy

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

    • builder

      static RecurringOrderFailureErrorBuilder builder()
      builder factory method for RecurringOrderFailureError
      Returns:
      builder

    • builder

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

    • withRecurringOrderFailureError

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