Package com.commercetools.api.models.review

Interface ReviewTransitionStateAction

All Superinterfaces:
ResourceUpdateAction<ReviewUpdateAction>, ReviewUpdateAction
public interface ReviewTransitionStateAction extends ReviewUpdateAction

Transition to a new State. This update action produces the Review State Transition Message.

Example to create an instance using the builder pattern 

     ReviewTransitionStateAction reviewTransitionStateAction = ReviewTransitionStateAction.builder()
             .state(stateBuilder -> stateBuilder)
             .build()

  • Field Details

    • TRANSITION_STATE

      static final String TRANSITION_STATE
      discriminator value for ReviewTransitionStateAction
      See Also:

  • Method Details

    • getState

      @NotNull @Valid @NotNull @Valid StateResourceIdentifier getState()

      Value to set. If there is no State yet, the new State must be an initial State. If the existing State has transitions set, there must be a direct transition to the new State. If transitions is not set, no validation is performed. If the new State does not have the role ReviewIncludedInStatistics, the Review is not taken into account in the ratings statistics of the target.

      Returns:
      state

    • getForce

      Boolean getForce()

      Switch validations on or off.

      Returns:
      force

    • setState

      void setState(StateResourceIdentifier state)

      Value to set. If there is no State yet, the new State must be an initial State. If the existing State has transitions set, there must be a direct transition to the new State. If transitions is not set, no validation is performed. If the new State does not have the role ReviewIncludedInStatistics, the Review is not taken into account in the ratings statistics of the target.

      Parameters:
      state - value to be set

    • setForce

      void setForce(Boolean force)

      Switch validations on or off.

      Parameters:
      force - value to be set

    • of

      static ReviewTransitionStateAction of()
      factory method
      Returns:
      instance of ReviewTransitionStateAction

    • of

      static ReviewTransitionStateAction of(ReviewTransitionStateAction template)
      factory method to create a shallow copy ReviewTransitionStateAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static ReviewTransitionStateAction deepCopy(@Nullable ReviewTransitionStateAction template)
      factory method to create a deep copy of ReviewTransitionStateAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ReviewTransitionStateActionBuilder builder()
      builder factory method for ReviewTransitionStateAction
      Returns:
      builder

    • builder

      static ReviewTransitionStateActionBuilder builder(ReviewTransitionStateAction template)
      create builder for ReviewTransitionStateAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withReviewTransitionStateAction

      default <T> T withReviewTransitionStateAction(Function<ReviewTransitionStateAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ReviewTransitionStateAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference