Interface StateTypeEnum

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
StateTypeEnum.StateTypeEnumEnum

public interface StateTypeEnum extends JsonEnum

Resource or object type the State can be assigned to.

  • Field Details

    • ORDER_STATE

      static final StateTypeEnum ORDER_STATE

      Used by Orders.

    • RECURRING_ORDER_STATE

      static final StateTypeEnum RECURRING_ORDER_STATE

      Used by RecurringOrders.

    • LINE_ITEM_STATE

      static final StateTypeEnum LINE_ITEM_STATE

      Used by LineItems and CustomLineItems in Carts and Orders, with the builtin field always set to true by default. In addition, the initial field is set to true upon creation.

    • PRODUCT_STATE

      static final StateTypeEnum PRODUCT_STATE

      Used by Products.

    • REVIEW_STATE

      static final StateTypeEnum REVIEW_STATE

      Used by Reviews.

    • PAYMENT_STATE

      static final StateTypeEnum PAYMENT_STATE

      Used by PaymentStatus in Payments.

    • QUOTE_REQUEST_STATE

      static final StateTypeEnum QUOTE_REQUEST_STATE

      Used by QuoteRequest.

    • STAGED_QUOTE_STATE

      static final StateTypeEnum STAGED_QUOTE_STATE

      Used by StagedQuote.

    • QUOTE_STATE

      static final StateTypeEnum QUOTE_STATE

      Used by Quote.

  • 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 StateTypeEnum findEnum(String value)
      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

      static Optional<StateTypeEnum> 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 StateTypeEnum[] values()
      possible enum values
      Returns:
      array of possible enum values