Package com.commercetools.api.models.product

Interface ProductAddToCategoryAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

All Known Implementing Classes:

ProductAddToCategoryActionImpl

public interface ProductAddToCategoryAction
extends ProductUpdateAction

Produces the ProductAddedToCategory Message.

Example to create an instance using the builder pattern

     ProductAddToCategoryAction productAddToCategoryAction = ProductAddToCategoryAction.builder()
             .category(categoryBuilder -> categoryBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_TO_CATEGORY	discriminator value for ProductAddToCategoryAction

Method Summary

Modifier and Type	Method	Description
static ProductAddToCategoryActionBuilder	builder()	builder factory method for ProductAddToCategoryAction
static ProductAddToCategoryActionBuilder	builder(ProductAddToCategoryAction template)	create builder for ProductAddToCategoryAction instance
static ProductAddToCategoryAction	deepCopy(ProductAddToCategoryAction template)	factory method to create a deep copy of ProductAddToCategoryAction
@NotNull @Valid CategoryResourceIdentifier	getCategory()	The Category to add.
String	getOrderHint()	A string representing a number between 0 and 1.
Boolean	getStaged()	If true, only the staged categories and categoryOrderHints are updated.
static ProductAddToCategoryAction	of()	factory method
static ProductAddToCategoryAction	of(ProductAddToCategoryAction template)	factory method to create a shallow copy ProductAddToCategoryAction
void	setCategory(CategoryResourceIdentifier category)	The Category to add.
void	setOrderHint(String orderHint)	A string representing a number between 0 and 1.
void	setStaged(Boolean staged)	If true, only the staged categories and categoryOrderHints are updated.
static com.fasterxml.jackson.core.type.TypeReference<ProductAddToCategoryAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductAddToCategoryAction(Function<ProductAddToCategoryAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product.ProductUpdateAction

getAction, withProductUpdateAction

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

get

Field Details

ADD_TO_CATEGORY

static final String ADD_TO_CATEGORY

discriminator value for ProductAddToCategoryAction

See Also:

• Constant Field Values

Method Details

getCategory

@NotNull
@Valid
@NotNull @Valid CategoryResourceIdentifier getCategory()

The Category to add.

Returns:

category

getOrderHint

String getOrderHint()

A string representing a number between 0 and 1. Must start with 0. and cannot end with 0. If empty, any existing value will be removed.

Returns:

orderHint

getStaged

Boolean getStaged()

If true, only the staged categories and categoryOrderHints are updated. If false, both the current and staged categories and categoryOrderHints are updated.

Returns:

staged

setCategory

void setCategory(CategoryResourceIdentifier category)

The Category to add.

Parameters:

category - value to be set

setOrderHint

void setOrderHint(String orderHint)

A string representing a number between 0 and 1. Must start with 0. and cannot end with 0. If empty, any existing value will be removed.

Parameters:

orderHint - value to be set

setStaged

void setStaged(Boolean staged)

If true, only the staged categories and categoryOrderHints are updated. If false, both the current and staged categories and categoryOrderHints are updated.

Parameters:

staged - value to be set

of

static ProductAddToCategoryAction of()

factory method

Returns:

instance of ProductAddToCategoryAction

of

static ProductAddToCategoryAction of(ProductAddToCategoryAction template)

factory method to create a shallow copy ProductAddToCategoryAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductAddToCategoryAction deepCopy(@Nullable
 ProductAddToCategoryAction template)

factory method to create a deep copy of ProductAddToCategoryAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductAddToCategoryActionBuilder builder()

builder factory method for ProductAddToCategoryAction

Returns:

builder

builder

static ProductAddToCategoryActionBuilder builder(ProductAddToCategoryAction template)

create builder for ProductAddToCategoryAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductAddToCategoryAction

default <T> T withProductAddToCategoryAction(Function<ProductAddToCategoryAction,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<ProductAddToCategoryAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference