Interface StateTypeEnum
- All Superinterfaces:
JsonEnum
- All Known Implementing Classes:
StateTypeEnum.StateTypeEnumEnum
Resource or object type the State can be assigned to.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumpossible values of StateTypeEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StateTypeEnumUsed by LineItems and CustomLineItems in Carts and Orders, with thebuiltinfield always set totrueby default.static final StateTypeEnumUsed by Orders.static final StateTypeEnumUsed by PaymentStatus in Payments.static final StateTypeEnumUsed by Products.static final StateTypeEnumUsed by QuoteRequest.static final StateTypeEnumUsed by Quote.static final StateTypeEnumUsed by RecurringOrders.static final StateTypeEnumUsed by Reviews.static final StateTypeEnumUsed by StagedQuote. -
Method Summary
Modifier and TypeMethodDescriptionstatic StateTypeEnumfactory method for a enum value of StateTypeEnum if no enum has been found an anonymous instance will be createdstatic Optional<StateTypeEnum>findEnumViaJsonName(String jsonName) method to find enum using the JSON valuethe JSON valuename()the enum valuetoString()convert value to stringstatic StateTypeEnum[]values()possible enum values
-
Field Details
-
ORDER_STATE
Used by Orders.
-
RECURRING_ORDER_STATE
Used by RecurringOrders.
-
LINE_ITEM_STATE
Used by LineItems and CustomLineItems in Carts and Orders, with the
builtinfield always set totrueby default. In addition, theinitialfield is set totrueupon creation. -
PRODUCT_STATE
Used by Products.
-
REVIEW_STATE
Used by Reviews.
-
PAYMENT_STATE
Used by PaymentStatus in Payments.
-
QUOTE_REQUEST_STATE
Used by QuoteRequest.
-
STAGED_QUOTE_STATE
Used by StagedQuote.
-
QUOTE_STATE
Used by Quote.
-
-
Method Details
-
getJsonName
String getJsonName()the JSON value- Specified by:
getJsonNamein 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 StateTypeEnum 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
-