Interface RecurringOrderState
- All Superinterfaces:
JsonEnum
- All Known Implementing Classes:
RecurringOrderState.RecurringOrderStateEnum
Indicates the state of the RecurringOrder.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
possible values of RecurringOrderState -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final RecurringOrderState
The default state of a new RecurringOrder.static final RecurringOrderState
Indicates that the RecurringOrder is canceled.static final RecurringOrderState
Indicates that the RecurringOrder has expired.static final RecurringOrderState
Indicates that the process of creating new orders has failed.static final RecurringOrderState
Indicates that the RecurringOrder is paused. -
Method Summary
Modifier and TypeMethodDescriptionstatic RecurringOrderState
factory method for a enum value of RecurringOrderState if no enum has been found an anonymous instance will be createdstatic Optional<RecurringOrderState>
findEnumViaJsonName
(String jsonName) method to find enum using the JSON valuethe JSON valuename()
the enum valuetoString()
convert value to stringstatic RecurringOrderState[]
values()
possible enum values
-
Field Details
-
ACTIVE
The default state of a new RecurringOrder.
-
PAUSED
Indicates that the RecurringOrder is paused.
-
EXPIRED
Indicates that the RecurringOrder has expired.
-
CANCELED
Indicates that the RecurringOrder is canceled.
-
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 interfaceJsonEnum
- Returns:
- json value
-
name
String name()the enum value -
toString
String toString()convert value to string -
findEnum
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
method to find enum using the JSON value- Parameters:
jsonName
- the json value to be wrapped- Returns:
- optional of enum instance
-
values
possible enum values- Returns:
- array of possible enum values
-