Package com.commercetools.api.models.product

Interface ProductSetCategoryOrderHintAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

All Known Implementing Classes:

ProductSetCategoryOrderHintActionImpl

public interface ProductSetCategoryOrderHintAction
extends ProductUpdateAction

ProductSetCategoryOrderHintAction Example to create an instance using the builder pattern

     ProductSetCategoryOrderHintAction productSetCategoryOrderHintAction = ProductSetCategoryOrderHintAction.builder()
             .categoryId("{categoryId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CATEGORY_ORDER_HINT	discriminator value for ProductSetCategoryOrderHintAction

Method Summary

Modifier and Type	Method	Description
static ProductSetCategoryOrderHintActionBuilder	builder()	builder factory method for ProductSetCategoryOrderHintAction
static ProductSetCategoryOrderHintActionBuilder	builder(ProductSetCategoryOrderHintAction template)	create builder for ProductSetCategoryOrderHintAction instance
static ProductSetCategoryOrderHintAction	deepCopy(ProductSetCategoryOrderHintAction template)	factory method to create a deep copy of ProductSetCategoryOrderHintAction
@NotNull String	getCategoryId()	The id of the Category to add the orderHint.
String	getOrderHint()	A string representing a number between 0 and 1.
Boolean	getStaged()	If true, only the staged categoryOrderHints is updated.
static ProductSetCategoryOrderHintAction	of()	factory method
static ProductSetCategoryOrderHintAction	of(ProductSetCategoryOrderHintAction template)	factory method to create a shallow copy ProductSetCategoryOrderHintAction
void	setCategoryId(String categoryId)	The id of the Category to add the orderHint.
void	setOrderHint(String orderHint)	A string representing a number between 0 and 1.
void	setStaged(Boolean staged)	If true, only the staged categoryOrderHints is updated.
static com.fasterxml.jackson.core.type.TypeReference<ProductSetCategoryOrderHintAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductSetCategoryOrderHintAction(Function<ProductSetCategoryOrderHintAction,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

SET_CATEGORY_ORDER_HINT

static final String SET_CATEGORY_ORDER_HINT

discriminator value for ProductSetCategoryOrderHintAction

See Also:

• Constant Field Values

Method Details

getCategoryId

@NotNull
@NotNull String getCategoryId()

The id of the Category to add the orderHint.

Returns:

categoryId

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 categoryOrderHints is updated. If false, both the current and staged categoryOrderHints are updated.

Returns:

staged

setCategoryId

void setCategoryId(String categoryId)

The id of the Category to add the orderHint.

Parameters:

categoryId - 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 categoryOrderHints is updated. If false, both the current and staged categoryOrderHints are updated.

Parameters:

staged - value to be set

of

static ProductSetCategoryOrderHintAction of()

factory method

Returns:

instance of ProductSetCategoryOrderHintAction

of

static ProductSetCategoryOrderHintAction of(ProductSetCategoryOrderHintAction template)

factory method to create a shallow copy ProductSetCategoryOrderHintAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductSetCategoryOrderHintAction deepCopy(@Nullable
 ProductSetCategoryOrderHintAction template)

factory method to create a deep copy of ProductSetCategoryOrderHintAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductSetCategoryOrderHintActionBuilder builder()

builder factory method for ProductSetCategoryOrderHintAction

Returns:

builder

builder

static ProductSetCategoryOrderHintActionBuilder builder(ProductSetCategoryOrderHintAction template)

create builder for ProductSetCategoryOrderHintAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductSetCategoryOrderHintAction

default <T> T withProductSetCategoryOrderHintAction(Function<ProductSetCategoryOrderHintAction,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<ProductSetCategoryOrderHintAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference