Package com.commercetools.api.models.business_unit

Interface BusinessUnitSetAddressCustomTypeAction

All Superinterfaces:

BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>

public interface BusinessUnitSetAddressCustomTypeAction
extends BusinessUnitUpdateAction

Adding or updating a Custom Type on an Address of a Business Unit generates the BusinessUnitAddressCustomTypeSet Message, and removing one generates the BusinessUnitAddressCustomTypeRemoved Message.

Example to create an instance using the builder pattern

     BusinessUnitSetAddressCustomTypeAction businessUnitSetAddressCustomTypeAction = BusinessUnitSetAddressCustomTypeAction.builder()
             .addressId("{addressId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ADDRESS_CUSTOM_TYPE	discriminator value for BusinessUnitSetAddressCustomTypeAction

Method Summary

Modifier and Type	Method	Description
static BusinessUnitSetAddressCustomTypeActionBuilder	builder()	builder factory method for BusinessUnitSetAddressCustomTypeAction
static BusinessUnitSetAddressCustomTypeActionBuilder	builder(BusinessUnitSetAddressCustomTypeAction template)	create builder for BusinessUnitSetAddressCustomTypeAction instance
static BusinessUnitSetAddressCustomTypeAction	deepCopy(BusinessUnitSetAddressCustomTypeAction template)	factory method to create a deep copy of BusinessUnitSetAddressCustomTypeAction
@NotNull String	getAddressId()	ID of the address to be extended.
@Valid FieldContainer	getFields()	Sets the Custom Fields for the address.
@Valid TypeResourceIdentifier	getType()	Defines the Type that extends the address with Custom Fields.
static BusinessUnitSetAddressCustomTypeAction	of()	factory method
static BusinessUnitSetAddressCustomTypeAction	of(BusinessUnitSetAddressCustomTypeAction template)	factory method to create a shallow copy BusinessUnitSetAddressCustomTypeAction
void	setAddressId(String addressId)	ID of the address to be extended.
void	setFields(FieldContainer fields)	Sets the Custom Fields for the address.
void	setType(TypeResourceIdentifier type)	Defines the Type that extends the address with Custom Fields.
static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitSetAddressCustomTypeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBusinessUnitSetAddressCustomTypeAction(Function<BusinessUnitSetAddressCustomTypeAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.business_unit.BusinessUnitUpdateAction

getAction, withBusinessUnitUpdateAction

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

get

Field Details

SET_ADDRESS_CUSTOM_TYPE

static final String SET_ADDRESS_CUSTOM_TYPE

discriminator value for BusinessUnitSetAddressCustomTypeAction

See Also:

• Constant Field Values

Method Details

getType

@Valid
@Valid TypeResourceIdentifier getType()

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

Returns:

type

getFields

@Valid
@Valid FieldContainer getFields()

Sets the Custom Fields for the address.

Returns:

fields

getAddressId

@NotNull
@NotNull String getAddressId()

ID of the address to be extended.

Returns:

addressId

setType

void setType(TypeResourceIdentifier type)

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

Parameters:

type - value to be set

setFields

void setFields(FieldContainer fields)

Sets the Custom Fields for the address.

Parameters:

fields - value to be set

setAddressId

void setAddressId(String addressId)

ID of the address to be extended.

Parameters:

addressId - value to be set

of

static BusinessUnitSetAddressCustomTypeAction of()

factory method

Returns:

instance of BusinessUnitSetAddressCustomTypeAction

of

static BusinessUnitSetAddressCustomTypeAction of(BusinessUnitSetAddressCustomTypeAction template)

factory method to create a shallow copy BusinessUnitSetAddressCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitSetAddressCustomTypeAction deepCopy(@Nullable
 BusinessUnitSetAddressCustomTypeAction template)

factory method to create a deep copy of BusinessUnitSetAddressCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitSetAddressCustomTypeActionBuilder builder()

builder factory method for BusinessUnitSetAddressCustomTypeAction

Returns:

builder

builder

static BusinessUnitSetAddressCustomTypeActionBuilder builder(BusinessUnitSetAddressCustomTypeAction template)

create builder for BusinessUnitSetAddressCustomTypeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitSetAddressCustomTypeAction

default <T> T withBusinessUnitSetAddressCustomTypeAction(Function<BusinessUnitSetAddressCustomTypeAction,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<BusinessUnitSetAddressCustomTypeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference