Package com.commercetools.api.models.recurring_order

Interface RecurringOrderSetCustomFieldAction

All Superinterfaces:

RecurringOrderUpdateAction

public interface RecurringOrderSetCustomFieldAction
extends RecurringOrderUpdateAction

Adding a Custom Field to a Recurring Order generates the RecurringOrderCustomFieldAdded Message, removing one generates the RecurringOrderCustomFieldRemoved Message, and updating an existing one generates the RecurringOrderCustomFieldChanged Message.

Example to create an instance using the builder pattern

     RecurringOrderSetCustomFieldAction recurringOrderSetCustomFieldAction = RecurringOrderSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_FIELD	discriminator value for RecurringOrderSetCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static RecurringOrderSetCustomFieldActionBuilder	builder()	builder factory method for RecurringOrderSetCustomFieldAction
static RecurringOrderSetCustomFieldActionBuilder	builder(RecurringOrderSetCustomFieldAction template)	create builder for RecurringOrderSetCustomFieldAction instance
RecurringOrderSetCustomFieldAction	copyDeep()
static RecurringOrderSetCustomFieldAction	deepCopy(RecurringOrderSetCustomFieldAction template)	factory method to create a deep copy of RecurringOrderSetCustomFieldAction
@NotNull String	getName()	Name of the Custom Field.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
static RecurringOrderSetCustomFieldAction	of()	factory method
static RecurringOrderSetCustomFieldAction	of(RecurringOrderSetCustomFieldAction template)	factory method to create a shallow copy RecurringOrderSetCustomFieldAction
void	setName(String name)	Name of the Custom Field.
void	setValue(Object value)	If value is absent or null, this field will be removed if it exists.
static com.fasterxml.jackson.core.type.TypeReference<RecurringOrderSetCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withRecurringOrderSetCustomFieldAction(Function<RecurringOrderSetCustomFieldAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.recurring_order.RecurringOrderUpdateAction

getAction, withRecurringOrderUpdateAction

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for RecurringOrderSetCustomFieldAction

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getValue

Object getValue()

If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Returns:

value

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setValue

void setValue(Object value)

If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Parameters:

value - value to be set

of

static RecurringOrderSetCustomFieldAction of()

factory method

Returns:

instance of RecurringOrderSetCustomFieldAction

of

static RecurringOrderSetCustomFieldAction of(RecurringOrderSetCustomFieldAction template)

factory method to create a shallow copy RecurringOrderSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderSetCustomFieldAction copyDeep()

Specified by:

copyDeep in interface RecurringOrderUpdateAction

deepCopy

@Nullable
static RecurringOrderSetCustomFieldAction deepCopy(@Nullable
 RecurringOrderSetCustomFieldAction template)

factory method to create a deep copy of RecurringOrderSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderSetCustomFieldActionBuilder builder()

builder factory method for RecurringOrderSetCustomFieldAction

Returns:

builder

builder

static RecurringOrderSetCustomFieldActionBuilder builder(RecurringOrderSetCustomFieldAction template)

create builder for RecurringOrderSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderSetCustomFieldAction

default <T> T withRecurringOrderSetCustomFieldAction(Function<RecurringOrderSetCustomFieldAction,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<RecurringOrderSetCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference