Package com.commercetools.api.models.message

Interface ProductAddedToCategoryMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface ProductAddedToCategoryMessagePayload
extends MessagePayload

Generated after a successful Add to Category update action.

Example to create an instance using the builder pattern

     ProductAddedToCategoryMessagePayload productAddedToCategoryMessagePayload = ProductAddedToCategoryMessagePayload.builder()
             .category(categoryBuilder -> categoryBuilder)
             .staged(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_ADDED_TO_CATEGORY	discriminator value for ProductAddedToCategoryMessagePayload

Method Summary

Modifier and Type	Method	Description
static ProductAddedToCategoryMessagePayloadBuilder	builder()	builder factory method for ProductAddedToCategoryMessagePayload
static ProductAddedToCategoryMessagePayloadBuilder	builder(ProductAddedToCategoryMessagePayload template)	create builder for ProductAddedToCategoryMessagePayload instance
ProductAddedToCategoryMessagePayload	copyDeep()
static ProductAddedToCategoryMessagePayload	deepCopy(ProductAddedToCategoryMessagePayload template)	factory method to create a deep copy of ProductAddedToCategoryMessagePayload
@NotNull @Valid CategoryReference	getCategory()	Category the Product was added to.
@NotNull Boolean	getStaged()	Whether the update was only applied to the staged Product Projection.
static ProductAddedToCategoryMessagePayload	of()	factory method
static ProductAddedToCategoryMessagePayload	of(ProductAddedToCategoryMessagePayload template)	factory method to create a shallow copy ProductAddedToCategoryMessagePayload
void	setCategory(CategoryReference category)	Category the Product was added to.
void	setStaged(Boolean staged)	Whether the update was only applied to the staged Product Projection.
static com.fasterxml.jackson.core.type.TypeReference<ProductAddedToCategoryMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductAddedToCategoryMessagePayload(Function<ProductAddedToCategoryMessagePayload,T> helper)	accessor map function

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

getType, withMessagePayload

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

as

Field Details

PRODUCT_ADDED_TO_CATEGORY

static final String PRODUCT_ADDED_TO_CATEGORY

discriminator value for ProductAddedToCategoryMessagePayload

See Also:

• Constant Field Values

Method Details

getCategory

@NotNull
@Valid
@NotNull @Valid CategoryReference getCategory()

Category the Product was added to.

Returns:

category

getStaged

@NotNull
@NotNull Boolean getStaged()

Whether the update was only applied to the staged Product Projection.

Returns:

staged

setCategory

void setCategory(CategoryReference category)

Category the Product was added to.

Parameters:

category - value to be set

setStaged

void setStaged(Boolean staged)

Whether the update was only applied to the staged Product Projection.

Parameters:

staged - value to be set

of

static ProductAddedToCategoryMessagePayload of()

factory method

Returns:

instance of ProductAddedToCategoryMessagePayload

of

static ProductAddedToCategoryMessagePayload of(ProductAddedToCategoryMessagePayload template)

factory method to create a shallow copy ProductAddedToCategoryMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductAddedToCategoryMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static ProductAddedToCategoryMessagePayload deepCopy(@Nullable
 ProductAddedToCategoryMessagePayload template)

factory method to create a deep copy of ProductAddedToCategoryMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductAddedToCategoryMessagePayloadBuilder builder()

builder factory method for ProductAddedToCategoryMessagePayload

Returns:

builder

builder

static ProductAddedToCategoryMessagePayloadBuilder builder(ProductAddedToCategoryMessagePayload template)

create builder for ProductAddedToCategoryMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductAddedToCategoryMessagePayload

default <T> T withProductAddedToCategoryMessagePayload(Function<ProductAddedToCategoryMessagePayload,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<ProductAddedToCategoryMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference