Package com.commercetools.api.models.customer

Interface CustomerSetCustomTypeAction

All Superinterfaces:

CustomerUpdateAction, ResourceUpdateAction<CustomerUpdateAction>

public interface CustomerSetCustomTypeAction
extends CustomerUpdateAction

Adding or updating a Custom Type on a Customer generates the CustomerCustomTypeSet Message, removing one generates the CustomerCustomTypeRemoved Message.

Example to create an instance using the builder pattern

     CustomerSetCustomTypeAction customerSetCustomTypeAction = CustomerSetCustomTypeAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_TYPE	discriminator value for CustomerSetCustomTypeAction

Method Summary

Modifier and Type	Method	Description
static CustomerSetCustomTypeActionBuilder	builder()	builder factory method for CustomerSetCustomTypeAction
static CustomerSetCustomTypeActionBuilder	builder(CustomerSetCustomTypeAction template)	create builder for CustomerSetCustomTypeAction instance
CustomerSetCustomTypeAction	copyDeep()
static CustomerSetCustomTypeAction	deepCopy(CustomerSetCustomTypeAction template)	factory method to create a deep copy of CustomerSetCustomTypeAction
@Valid FieldContainer	getFields()	Object containing the Custom Fields fields for the Customer.
@Valid TypeResourceIdentifier	getType()	Defines the Type that extends the Customer with Custom Fields.
static CustomerSetCustomTypeAction	of()	factory method
static CustomerSetCustomTypeAction	of(CustomerSetCustomTypeAction template)	factory method to create a shallow copy CustomerSetCustomTypeAction
void	setFields(FieldContainer fields)	Object containing the Custom Fields fields for the Customer.
void	setType(TypeResourceIdentifier type)	Defines the Type that extends the Customer with Custom Fields.
static tools.jackson.core.type.TypeReference<CustomerSetCustomTypeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerSetCustomTypeAction(Function<CustomerSetCustomTypeAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.customer.CustomerUpdateAction

getAction, withCustomerUpdateAction

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

get

Field Details

SET_CUSTOM_TYPE

static final String SET_CUSTOM_TYPE

discriminator value for CustomerSetCustomTypeAction

See Also:

• Constant Field Values

Method Details

getType

@Valid
@Valid TypeResourceIdentifier getType()

Defines the Type that extends the Customer with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Customer.

Returns:

type

getFields

@Valid
@Valid FieldContainer getFields()

Object containing the Custom Fields fields for the Customer.

Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

Returns:

fields

setType

void setType(TypeResourceIdentifier type)

Defines the Type that extends the Customer with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Customer.

Parameters:

type - value to be set

setFields

void setFields(FieldContainer fields)

Object containing the Custom Fields fields for the Customer.

Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

Parameters:

fields - value to be set

of

static CustomerSetCustomTypeAction of()

factory method

Returns:

instance of CustomerSetCustomTypeAction

of

static CustomerSetCustomTypeAction of(CustomerSetCustomTypeAction template)

factory method to create a shallow copy CustomerSetCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerSetCustomTypeAction copyDeep()

Specified by:

copyDeep in interface CustomerUpdateAction

deepCopy

@Nullable
static CustomerSetCustomTypeAction deepCopy(@Nullable
 CustomerSetCustomTypeAction template)

factory method to create a deep copy of CustomerSetCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerSetCustomTypeActionBuilder builder()

builder factory method for CustomerSetCustomTypeAction

Returns:

builder

builder

static CustomerSetCustomTypeActionBuilder builder(CustomerSetCustomTypeAction template)

create builder for CustomerSetCustomTypeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerSetCustomTypeAction

default <T> T withCustomerSetCustomTypeAction(Function<CustomerSetCustomTypeAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<CustomerSetCustomTypeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference