Package com.commercetools.api.models.message

Interface ProductAddedToCategoryMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>

public interface ProductAddedToCategoryMessage
extends Message

Generated after a successful Add to Category update action.

Example to create an instance using the builder pattern

     ProductAddedToCategoryMessage productAddedToCategoryMessage = ProductAddedToCategoryMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .category(categoryBuilder -> categoryBuilder)
             .staged(true)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ProductAddedToCategoryMessageBuilder	builder()	builder factory method for ProductAddedToCategoryMessage
static ProductAddedToCategoryMessageBuilder	builder(ProductAddedToCategoryMessage template)	create builder for ProductAddedToCategoryMessage instance
ProductAddedToCategoryMessage	copyDeep()
static ProductAddedToCategoryMessage	deepCopy(ProductAddedToCategoryMessage template)	factory method to create a deep copy of ProductAddedToCategoryMessage
@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 ProductAddedToCategoryMessage	of()	factory method
static ProductAddedToCategoryMessage	of(ProductAddedToCategoryMessage template)	factory method to create a shallow copy ProductAddedToCategoryMessage
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<ProductAddedToCategoryMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductAddedToCategoryMessage(Function<ProductAddedToCategoryMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

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

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Field Details

PRODUCT_ADDED_TO_CATEGORY

static final String PRODUCT_ADDED_TO_CATEGORY

discriminator value for ProductAddedToCategoryMessage

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 ProductAddedToCategoryMessage of()

factory method

Returns:

instance of ProductAddedToCategoryMessage

of

static ProductAddedToCategoryMessage of(ProductAddedToCategoryMessage template)

factory method to create a shallow copy ProductAddedToCategoryMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductAddedToCategoryMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static ProductAddedToCategoryMessage deepCopy(@Nullable
 ProductAddedToCategoryMessage template)

factory method to create a deep copy of ProductAddedToCategoryMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductAddedToCategoryMessageBuilder builder()

builder factory method for ProductAddedToCategoryMessage

Returns:

builder

builder

static ProductAddedToCategoryMessageBuilder builder(ProductAddedToCategoryMessage template)

create builder for ProductAddedToCategoryMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductAddedToCategoryMessage

default <T> T withProductAddedToCategoryMessage(Function<ProductAddedToCategoryMessage,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<ProductAddedToCategoryMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference