io.sphere.sdk.reviews.messages

Class ReviewCreatedMessage

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.models.ResourceViewImpl<T,T>

io.sphere.sdk.models.ResourceImpl<Message>

io.sphere.sdk.messages.GenericMessageImpl<Review>

io.sphere.sdk.reviews.messages.ReviewCreatedMessage

All Implemented Interfaces:

GenericMessage<Review>, Message, CreationTimestamped, Identifiable<Message>, Referenceable<Message>, Resource<Message>, ResourceIdentifiable<Message>, ResourceView<Message,Message>, Timestamped, Versioned<Message>

public final class ReviewCreatedMessage
extends GenericMessageImpl<Review>

This message is the result of the create review request.

withType(client(), (Type type) -> {
    withCustomer(client(), (Customer customer) -> {
        withProduct(client(), (Product product) -> {
            withState(client(), StateDraft.of("initial-review-state", StateType.REVIEW_STATE), (State state) -> {
                final CustomFieldsDraft extraFields = CustomFieldsDraft.ofTypeKeyAndObjects(type.getKey(), singletonMap("screenshotUrls",
                        Collections.singleton("https://docs.commercetools.com/assets/img/CT-logo.svg")));
                final ReviewDraft reviewDraft = ReviewDraftBuilder.ofTitle("Commercetools rocks")
                        .authorName("John Smith")
                        .text("It is great.")
                        .rating(100)
                        .custom(extraFields)
                        .customer(customer)
                        .key("review1")
                        //only allow one review for a product from one customer
                        .uniquenessValue(product.getId() + "+" + customer.getId())
                        .locale(Locale.ENGLISH)
                        .state(state)
                        .target(product)
                        .build();

                final Review review = client().executeBlocking(ReviewCreateCommand.of(reviewDraft));

                assertThat(review.getAuthorName()).isEqualTo("John Smith");
                assertThat(review.getCustom().getFieldAsStringSet("screenshotUrls"))
                        .containsExactly("https://docs.commercetools.com/assets/img/CT-logo.svg");
                assertThat(review.getCustomer()).isEqualTo(customer.toReference());
                assertThat(review.getKey()).isEqualTo("review1");
                assertThat(review.getUniquenessValue()).isEqualTo(product.getId() + "+" + customer.getId());
                assertThat(review.getLocale()).isEqualTo(Locale.ENGLISH);
                assertThat(review.getAuthorName()).isEqualTo("John Smith");
                assertThat(review.getTitle()).isEqualTo("Commercetools rocks");
                assertThat(review.getText()).isEqualTo("It is great.");
                assertThat(review.getTarget()).isEqualTo(product.toReference());
                assertThat(review.getRating()).isEqualTo(100);
                assertThat(review.getState()).isEqualTo(state.toReference());
                assertThat(review.getCustomer()).isEqualTo(customer.toReference());

                final ProductProjection productProjection = client().executeBlocking(ProductProjectionByIdGet.ofStaged(product));
                assertThat(productProjection.getReviewRatingStatistics()).
                        as("the state has not the role ReviewIncludedInStatistics, so it is not accounted yet")
                        .isNull();

                //you can observe a message
                assertEventually(() -> {
                    final PagedQueryResult<ReviewCreatedMessage> pagedQueryResult = client().executeBlocking(MessageQuery.of()
                            .withPredicates(m -> m.resource().is(review))
                            .forMessageType(ReviewCreatedMessage.MESSAGE_HINT));

                    final Optional<ReviewCreatedMessage> paymentCreatedMessage = pagedQueryResult.head();

                    assertThat(paymentCreatedMessage).isPresent();
                    assertThat(paymentCreatedMessage.get().getReview().getId()).isEqualTo(review.getId());
                    assertThat(paymentCreatedMessage.get().getResource().getId()).isEqualTo(review.getId());
                });

                client().executeBlocking(ReviewDeleteCommand.of(review));
            });
        });
    });
});
See the test code.

See Also:

ReviewCreateCommand

Field Summary

Fields

Modifier and Type	Field and Description
static MessageDerivateHint<ReviewCreatedMessage>	MESSAGE_HINT
static String	MESSAGE_TYPE

Fields inherited from class io.sphere.sdk.messages.GenericMessageImpl

resource, resourceUserProvidedIdentifiers, resourceVersion, sequenceNumber, type

Method Summary

Modifier and Type	Method and Description
Review	getReview() Gets the review object at creation time.

Methods inherited from class io.sphere.sdk.messages.GenericMessageImpl

as, equals, getPayload, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, hashCode, toReference

Methods inherited from class io.sphere.sdk.models.ResourceViewImpl

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from class io.sphere.sdk.models.Base

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.sphere.sdk.messages.Message

referenceOfId, referenceTypeId, typeReference

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Field Detail

MESSAGE_TYPE

public static final String MESSAGE_TYPE

See Also:

Constant Field Values

MESSAGE_HINT

public static final MessageDerivateHint<ReviewCreatedMessage> MESSAGE_HINT

Method Detail

getReview

public Review getReview()

Gets the review object at creation time. This output can differ from an expanded Message.getResource().

Returns:

the review at creation time