Package com.commercetools.api.models.recurring_order

Interface RecurringOrderState

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
RecurringOrderState.RecurringOrderStateEnum
public interface RecurringOrderState extends JsonEnum

Indicates the state of the RecurringOrder.

  • Field Details

    • ACTIVE

      static final RecurringOrderState ACTIVE

      The default state of a new RecurringOrder.

    • PAUSED

      static final RecurringOrderState PAUSED

      Indicates that the RecurringOrder is paused.

    • EXPIRED

      static final RecurringOrderState EXPIRED

      Indicates that the RecurringOrder has expired.

    • CANCELED

      static final RecurringOrderState CANCELED

      Indicates that the RecurringOrder is canceled.

    • FAILED

      static final RecurringOrderState FAILED

      Indicates that the process of creating new orders has failed. The field failure stores the error encountered (inventory unavailable, etc). New orders will not be created until the issue is fixed.

  • Method Details

    • getJsonName

      String getJsonName()
      the JSON value
      Specified by:
      getJsonName in interface JsonEnum
      Returns:
      json value

    • name

      String name()
      the enum value
      Specified by:
      name in interface JsonEnum
      Returns:
      name

    • toString

      String toString()
      convert value to string
      Specified by:
      toString in interface JsonEnum
      Overrides:
      toString in class Object
      Returns:
      string representation

    • findEnum

      static RecurringOrderState findEnum(String value)
      factory method for a enum value of RecurringOrderState if no enum has been found an anonymous instance will be created
      Parameters:
      value - the enum value to be wrapped
      Returns:
      enum instance

    • findEnumViaJsonName

      static Optional<RecurringOrderState> findEnumViaJsonName(String jsonName)
      method to find enum using the JSON value
      Parameters:
      jsonName - the json value to be wrapped
      Returns:
      optional of enum instance

    • values

      static RecurringOrderState[] values()
      possible enum values
      Returns:
      array of possible enum values