Package com.commercetools.api.models.state

Interface StateRoleEnum

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
StateRoleEnum.StateRoleEnumEnum
public interface StateRoleEnum extends JsonEnum

For some resource types, a State can fulfill the following predefined roles:

  • Field Details

    • REVIEW_INCLUDED_IN_STATISTICS

      static final StateRoleEnum REVIEW_INCLUDED_IN_STATISTICS

      If a Review's state has this role its rating is taken into account for ReviewRatingStatistics. This role only applies for the ReviewState StateTypeEnum.

    • RETURN

      static final StateRoleEnum RETURN

      Used by Orders in the update action transitionLineItemState. This role only applies for the LineItemState StateTypeEnum.

  • 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 StateRoleEnum findEnum(String value)
      factory method for a enum value of StateRoleEnum 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<StateRoleEnum> 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 StateRoleEnum[] values()
      possible enum values
      Returns:
      array of possible enum values