io.sphere.sdk.reviews.messages.ReviewCreatedMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commercetools-models Show documentation

There is a newer version: 2.16.0

package io.sphere.sdk.reviews.messages;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.sphere.sdk.messages.GenericMessageImpl;
import io.sphere.sdk.messages.Message;
import io.sphere.sdk.messages.MessageDerivateHint;
import io.sphere.sdk.reviews.Review;

import java.time.ZonedDateTime;

/**
 * This message is the result of the create review request.
 *
 * {@include.example io.sphere.sdk.reviews.commands.ReviewCreateCommandIntegrationTest#createByCode()}
 *
 * @see io.sphere.sdk.reviews.commands.ReviewCreateCommand
 */
@JsonDeserialize(as = ReviewCreatedMessage.class)//important to override annotation in Message class
public final class ReviewCreatedMessage extends GenericMessageImpl {
    public static final String MESSAGE_TYPE = "ReviewCreated";
    public static final MessageDerivateHint MESSAGE_HINT =
            MessageDerivateHint.ofSingleMessageType(MESSAGE_TYPE, ReviewCreatedMessage.class, Review.referenceTypeId());

    private final Review review;

    @JsonCreator
    private ReviewCreatedMessage(final String id, final Long version, final ZonedDateTime createdAt, final ZonedDateTime lastModifiedAt, final JsonNode resource, final Long sequenceNumber, final Long resourceVersion, final String type, final Review review) {
        super(id, version, createdAt, lastModifiedAt, resource, sequenceNumber, resourceVersion, type, Review.class);
        this.review = review;
    }

    /**
     * Gets the review object at creation time. This output can differ from an expanded {@link Message#getResource()}.
     *
     * @return the review at creation time
     */
    public Review getReview() {
        return review;
    }
}