Package com.commercetools.api.models.type

Interface TypeChangeLocalizedEnumValueOrderAction

All Superinterfaces:

ResourceUpdateAction<TypeUpdateAction>, TypeUpdateAction

All Known Implementing Classes:

TypeChangeLocalizedEnumValueOrderActionImpl

public interface TypeChangeLocalizedEnumValueOrderAction
extends TypeUpdateAction

Changes the order of LocalizedEnumValues in a LocalizedEnumType FieldDefinition. This update action can be used to update a LocalizedEnumType FieldDefinition and a SetType of LocalizedEnumType FieldDefinitions.

Example to create an instance using the builder pattern

     TypeChangeLocalizedEnumValueOrderAction typeChangeLocalizedEnumValueOrderAction = TypeChangeLocalizedEnumValueOrderAction.builder()
             .fieldName("{fieldName}")
             .plusKeys(keysBuilder -> keysBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_LOCALIZED_ENUM_VALUE_ORDER	discriminator value for TypeChangeLocalizedEnumValueOrderAction

Method Summary

Modifier and Type	Method	Description
static TypeChangeLocalizedEnumValueOrderActionBuilder	builder()	builder factory method for TypeChangeLocalizedEnumValueOrderAction
static TypeChangeLocalizedEnumValueOrderActionBuilder	builder(TypeChangeLocalizedEnumValueOrderAction template)	create builder for TypeChangeLocalizedEnumValueOrderAction instance
static TypeChangeLocalizedEnumValueOrderAction	deepCopy(TypeChangeLocalizedEnumValueOrderAction template)	factory method to create a deep copy of TypeChangeLocalizedEnumValueOrderAction
@NotNull String	getFieldName()	name of the Field Definition to update.
@NotNull List<String>	getKeys()	Must match the set of keys of the LocalizedEnumValues in the FieldDefinition (up to order).
static TypeChangeLocalizedEnumValueOrderAction	of()	factory method
static TypeChangeLocalizedEnumValueOrderAction	of(TypeChangeLocalizedEnumValueOrderAction template)	factory method to create a shallow copy TypeChangeLocalizedEnumValueOrderAction
void	setFieldName(String fieldName)	name of the Field Definition to update.
void	setKeys(String... keys)	Must match the set of keys of the LocalizedEnumValues in the FieldDefinition (up to order).
void	setKeys(List<String> keys)	Must match the set of keys of the LocalizedEnumValues in the FieldDefinition (up to order).
static com.fasterxml.jackson.core.type.TypeReference<TypeChangeLocalizedEnumValueOrderAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withTypeChangeLocalizedEnumValueOrderAction(Function<TypeChangeLocalizedEnumValueOrderAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.type.TypeUpdateAction

getAction, withTypeUpdateAction

Field Details

CHANGE_LOCALIZED_ENUM_VALUE_ORDER

static final String CHANGE_LOCALIZED_ENUM_VALUE_ORDER

discriminator value for TypeChangeLocalizedEnumValueOrderAction

See Also:

• Constant Field Values

Method Details

getFieldName

@NotNull
@NotNull String getFieldName()

name of the Field Definition to update.

Returns:

fieldName

getKeys

@NotNull
@NotNull List<String> getKeys()

Must match the set of keys of the LocalizedEnumValues in the FieldDefinition (up to order).

Returns:

keys

setFieldName

void setFieldName(String fieldName)

name of the Field Definition to update.

Parameters:

fieldName - value to be set

setKeys

void setKeys(String... keys)

Must match the set of keys of the LocalizedEnumValues in the FieldDefinition (up to order).

Parameters:

keys - values to be set

setKeys

void setKeys(List<String> keys)

Must match the set of keys of the LocalizedEnumValues in the FieldDefinition (up to order).

Parameters:

keys - values to be set

of

static TypeChangeLocalizedEnumValueOrderAction of()

factory method

Returns:

instance of TypeChangeLocalizedEnumValueOrderAction

of

static TypeChangeLocalizedEnumValueOrderAction of(TypeChangeLocalizedEnumValueOrderAction template)

factory method to create a shallow copy TypeChangeLocalizedEnumValueOrderAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static TypeChangeLocalizedEnumValueOrderAction deepCopy(@Nullable
 TypeChangeLocalizedEnumValueOrderAction template)

factory method to create a deep copy of TypeChangeLocalizedEnumValueOrderAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static TypeChangeLocalizedEnumValueOrderActionBuilder builder()

builder factory method for TypeChangeLocalizedEnumValueOrderAction

Returns:

builder

builder

static TypeChangeLocalizedEnumValueOrderActionBuilder builder(TypeChangeLocalizedEnumValueOrderAction template)

create builder for TypeChangeLocalizedEnumValueOrderAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withTypeChangeLocalizedEnumValueOrderAction

default <T> T withTypeChangeLocalizedEnumValueOrderAction(Function<TypeChangeLocalizedEnumValueOrderAction,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<TypeChangeLocalizedEnumValueOrderAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference