Package com.commercetools.api.models.message

Interface ReviewStateTransitionMessagePayload

All Superinterfaces:

MessagePayload

All Known Implementing Classes:

ReviewStateTransitionMessagePayloadImpl

public interface ReviewStateTransitionMessagePayload
extends MessagePayload

Generated after a successful Transition State update action.

Example to create an instance using the builder pattern

     ReviewStateTransitionMessagePayload reviewStateTransitionMessagePayload = ReviewStateTransitionMessagePayload.builder()
             .newState(newStateBuilder -> newStateBuilder)
             .oldIncludedInStatistics(true)
             .newIncludedInStatistics(true)
             .force(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REVIEW_STATE_TRANSITION	discriminator value for ReviewStateTransitionMessagePayload

Method Summary

Modifier and Type	Method	Description
static ReviewStateTransitionMessagePayloadBuilder	builder()	builder factory method for ReviewStateTransitionMessagePayload
static ReviewStateTransitionMessagePayloadBuilder	builder(ReviewStateTransitionMessagePayload template)	create builder for ReviewStateTransitionMessagePayload instance
static ReviewStateTransitionMessagePayload	deepCopy(ReviewStateTransitionMessagePayload template)	factory method to create a deep copy of ReviewStateTransitionMessagePayload
@NotNull Boolean	getForce()	Whether State transition validations were turned off during the Transition State update action.
@NotNull Boolean	getNewIncludedInStatistics()	Whether the new Review was taken into account in the rating statistics of the target after the state transition.
@NotNull @Valid StateReference	getNewState()	State of the Review after the Transition State update action.
@NotNull Boolean	getOldIncludedInStatistics()	Whether the old Review was taken into account in the rating statistics of the target before the state transition.
@Valid StateReference	getOldState()	State of the Review before the Transition State update action.
@Valid Reference	getTarget()	Reference to the resource that the Review belongs to.
static ReviewStateTransitionMessagePayload	of()	factory method
static ReviewStateTransitionMessagePayload	of(ReviewStateTransitionMessagePayload template)	factory method to create a shallow copy ReviewStateTransitionMessagePayload
void	setForce(Boolean force)	Whether State transition validations were turned off during the Transition State update action.
void	setNewIncludedInStatistics(Boolean newIncludedInStatistics)	Whether the new Review was taken into account in the rating statistics of the target after the state transition.
void	setNewState(StateReference newState)	State of the Review after the Transition State update action.
void	setOldIncludedInStatistics(Boolean oldIncludedInStatistics)	Whether the old Review was taken into account in the rating statistics of the target before the state transition.
void	setOldState(StateReference oldState)	State of the Review before the Transition State update action.
void	setTarget(Reference target)	Reference to the resource that the Review belongs to.
static com.fasterxml.jackson.core.type.TypeReference<ReviewStateTransitionMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withReviewStateTransitionMessagePayload(Function<ReviewStateTransitionMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Field Details

REVIEW_STATE_TRANSITION

static final String REVIEW_STATE_TRANSITION

discriminator value for ReviewStateTransitionMessagePayload

See Also:

• Constant Field Values

Method Details

getOldState

@Valid
@Valid StateReference getOldState()

State of the Review before the Transition State update action.

Returns:

oldState

getNewState

@NotNull
@Valid
@NotNull @Valid StateReference getNewState()

State of the Review after the Transition State update action.

Returns:

newState

getOldIncludedInStatistics

@NotNull
@NotNull Boolean getOldIncludedInStatistics()

Whether the old Review was taken into account in the rating statistics of the target before the state transition.

Returns:

oldIncludedInStatistics

getNewIncludedInStatistics

@NotNull
@NotNull Boolean getNewIncludedInStatistics()

Whether the new Review was taken into account in the rating statistics of the target after the state transition.

Returns:

newIncludedInStatistics

getTarget

@Valid
@Valid Reference getTarget()

Reference to the resource that the Review belongs to.

Returns:

target

getForce

@NotNull
@NotNull Boolean getForce()

Whether State transition validations were turned off during the Transition State update action.

Returns:

force

setOldState

void setOldState(StateReference oldState)

State of the Review before the Transition State update action.

Parameters:

oldState - value to be set

setNewState

void setNewState(StateReference newState)

State of the Review after the Transition State update action.

Parameters:

newState - value to be set

setOldIncludedInStatistics

void setOldIncludedInStatistics(Boolean oldIncludedInStatistics)

Whether the old Review was taken into account in the rating statistics of the target before the state transition.

Parameters:

oldIncludedInStatistics - value to be set

setNewIncludedInStatistics

void setNewIncludedInStatistics(Boolean newIncludedInStatistics)

Whether the new Review was taken into account in the rating statistics of the target after the state transition.

Parameters:

newIncludedInStatistics - value to be set

setTarget

void setTarget(Reference target)

Reference to the resource that the Review belongs to.

Parameters:

target - value to be set

setForce

void setForce(Boolean force)

Whether State transition validations were turned off during the Transition State update action.

Parameters:

force - value to be set

of

static ReviewStateTransitionMessagePayload of()

factory method

Returns:

instance of ReviewStateTransitionMessagePayload

of

static ReviewStateTransitionMessagePayload of(ReviewStateTransitionMessagePayload template)

factory method to create a shallow copy ReviewStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ReviewStateTransitionMessagePayload deepCopy(@Nullable
 ReviewStateTransitionMessagePayload template)

factory method to create a deep copy of ReviewStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ReviewStateTransitionMessagePayloadBuilder builder()

builder factory method for ReviewStateTransitionMessagePayload

Returns:

builder

builder

static ReviewStateTransitionMessagePayloadBuilder builder(ReviewStateTransitionMessagePayload template)

create builder for ReviewStateTransitionMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withReviewStateTransitionMessagePayload

default <T> T withReviewStateTransitionMessagePayload(Function<ReviewStateTransitionMessagePayload,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<ReviewStateTransitionMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference