Package com.commercetools.api.models.product

Interface ProductSetDescriptionAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

All Known Implementing Classes:

ProductSetDescriptionActionImpl

public interface ProductSetDescriptionAction
extends ProductUpdateAction

ProductSetDescriptionAction Example to create an instance using the builder pattern

     ProductSetDescriptionAction productSetDescriptionAction = ProductSetDescriptionAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DESCRIPTION	discriminator value for ProductSetDescriptionAction

Method Summary

Modifier and Type	Method	Description
static ProductSetDescriptionActionBuilder	builder()	builder factory method for ProductSetDescriptionAction
static ProductSetDescriptionActionBuilder	builder(ProductSetDescriptionAction template)	create builder for ProductSetDescriptionAction instance
static ProductSetDescriptionAction	deepCopy(ProductSetDescriptionAction template)	factory method to create a deep copy of ProductSetDescriptionAction
@Valid LocalizedString	getDescription()	Value to set.
Boolean	getStaged()	If true, only the staged description is updated.
static ProductSetDescriptionAction	of()	factory method
static ProductSetDescriptionAction	of(ProductSetDescriptionAction template)	factory method to create a shallow copy ProductSetDescriptionAction
void	setDescription(LocalizedString description)	Value to set.
void	setStaged(Boolean staged)	If true, only the staged description is updated.
static com.fasterxml.jackson.core.type.TypeReference<ProductSetDescriptionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductSetDescriptionAction(Function<ProductSetDescriptionAction,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_DESCRIPTION

static final String SET_DESCRIPTION

discriminator value for ProductSetDescriptionAction

See Also:

• Constant Field Values

Method Details

getDescription

@Valid
@Valid LocalizedString getDescription()

Value to set. If empty, any existing value will be removed.

Returns:

description

getStaged

Boolean getStaged()

If true, only the staged description is updated. If false, both the current and staged description are updated.

Returns:

staged

setDescription

void setDescription(LocalizedString description)

Value to set. If empty, any existing value will be removed.

Parameters:

description - value to be set

setStaged

void setStaged(Boolean staged)

If true, only the staged description is updated. If false, both the current and staged description are updated.

Parameters:

staged - value to be set

of

static ProductSetDescriptionAction of()

factory method

Returns:

instance of ProductSetDescriptionAction

of

static ProductSetDescriptionAction of(ProductSetDescriptionAction template)

factory method to create a shallow copy ProductSetDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductSetDescriptionAction deepCopy(@Nullable
 ProductSetDescriptionAction template)

factory method to create a deep copy of ProductSetDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductSetDescriptionActionBuilder builder()

builder factory method for ProductSetDescriptionAction

Returns:

builder

builder

static ProductSetDescriptionActionBuilder builder(ProductSetDescriptionAction template)

create builder for ProductSetDescriptionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductSetDescriptionAction

default <T> T withProductSetDescriptionAction(Function<ProductSetDescriptionAction,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<ProductSetDescriptionAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference