Package com.commercetools.api.models.reservation

Interface ReservationState

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
ReservationState.ReservationStateEnum
public interface ReservationState extends JsonEnum

Status of the Reservation.

  • Field Details

    • CREATED

      static final ReservationState CREATED

      The availableQuantity of the item has been reduced by the reserved quantity, but the quantityOnStock remains unchanged.

    • UPDATED

      static final ReservationState UPDATED

      The reservation has been updated. If the quantity of an item changed, the availableQuantity is increased or decreased accordingly, while the quantityOnStock remains unchanged.

    • RELEASED

      static final ReservationState RELEASED

      The reserved quantity of the item has been released. The availableQuantity is increased accordingly.

    • EXPIRED

      static final ReservationState EXPIRED

      The reservation has expired and the availableQuantity is increased accordingly. Reservation expirations are eventually consistent, meaning it can take a few minutes for the status to update after expiration.

    • COMMITTED

      static final ReservationState COMMITTED

      The quantity of the item has been allocated for fulfillment. The quantityOnStock has been reduced by the reserved quantity.

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