Package com.commercetools.api.models.message

Interface ReviewRatingSetMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
All Known Implementing Classes:
ReviewRatingSetMessagePayloadImpl
public interface ReviewRatingSetMessagePayload extends MessagePayload

Generated after a successful Set Rating update action.

Example to create an instance using the builder pattern 

     ReviewRatingSetMessagePayload reviewRatingSetMessagePayload = ReviewRatingSetMessagePayload.builder()
             .includedInStatistics(true)
             .build()

  • Field Details

    • REVIEW_RATING_SET

      static final String REVIEW_RATING_SET
      discriminator value for ReviewRatingSetMessagePayload
      See Also:

  • Method Details

    • getOldRating

      Double getOldRating()

      The rating of the Review before the Set Rating update action.

      Returns:
      oldRating

    • getNewRating

      Double getNewRating()

      The rating of the Review after the Set Rating update action.

      Returns:
      newRating

    • getIncludedInStatistics

      @NotNull @NotNull Boolean getIncludedInStatistics()

      Whether the Review was taken into account in the ratings statistics of the target.

      Returns:
      includedInStatistics

    • getTarget

      @Valid @Valid Reference getTarget()

      Reference to the resource that the Review belongs to.

      Returns:
      target

    • setOldRating

      void setOldRating(Double oldRating)

      The rating of the Review before the Set Rating update action.

      Parameters:
      oldRating - value to be set

    • setNewRating

      void setNewRating(Double newRating)

      The rating of the Review after the Set Rating update action.

      Parameters:
      newRating - value to be set

    • setIncludedInStatistics

      void setIncludedInStatistics(Boolean includedInStatistics)

      Whether the Review was taken into account in the ratings statistics of the target.

      Parameters:
      includedInStatistics - value to be set

    • setTarget

      void setTarget(Reference target)

      Reference to the resource that the Review belongs to.

      Parameters:
      target - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ReviewRatingSetMessagePayloadBuilder builder()
      builder factory method for ReviewRatingSetMessagePayload
      Returns:
      builder

    • builder

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

    • withReviewRatingSetMessagePayload

      default <T> T withReviewRatingSetMessagePayload(Function<ReviewRatingSetMessagePayload,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<ReviewRatingSetMessagePayload> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference