Package com.commercetools.api.models.store

Interface StoreAddDistributionChannelAction

All Superinterfaces:

ResourceUpdateAction<StoreUpdateAction>, StoreUpdateAction

public interface StoreAddDistributionChannelAction
extends StoreUpdateAction

This update action produces the StoreDistributionChannelsChanged Message. It has no effect if a given distribution channel is already present in a Store.

Adding a Channel without the ProductDistribution ChannelRoleEnum returns a MissingRoleOnChannel error.

Example to create an instance using the builder pattern

     StoreAddDistributionChannelAction storeAddDistributionChannelAction = StoreAddDistributionChannelAction.builder()
             .distributionChannel(distributionChannelBuilder -> distributionChannelBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_DISTRIBUTION_CHANNEL	discriminator value for StoreAddDistributionChannelAction

Method Summary

Modifier and Type	Method	Description
static StoreAddDistributionChannelActionBuilder	builder()	builder factory method for StoreAddDistributionChannelAction
static StoreAddDistributionChannelActionBuilder	builder(StoreAddDistributionChannelAction template)	create builder for StoreAddDistributionChannelAction instance
StoreAddDistributionChannelAction	copyDeep()
static StoreAddDistributionChannelAction	deepCopy(StoreAddDistributionChannelAction template)	factory method to create a deep copy of StoreAddDistributionChannelAction
@NotNull @Valid ChannelResourceIdentifier	getDistributionChannel()	Value to append.
static StoreAddDistributionChannelAction	of()	factory method
static StoreAddDistributionChannelAction	of(StoreAddDistributionChannelAction template)	factory method to create a shallow copy StoreAddDistributionChannelAction
void	setDistributionChannel(ChannelResourceIdentifier distributionChannel)	Value to append.
static com.fasterxml.jackson.core.type.TypeReference<StoreAddDistributionChannelAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStoreAddDistributionChannelAction(Function<StoreAddDistributionChannelAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.store.StoreUpdateAction

getAction, withStoreUpdateAction

Field Details

ADD_DISTRIBUTION_CHANNEL

static final String ADD_DISTRIBUTION_CHANNEL

discriminator value for StoreAddDistributionChannelAction

See Also:

• Constant Field Values

Method Details

getDistributionChannel

@NotNull
@Valid
@NotNull @Valid ChannelResourceIdentifier getDistributionChannel()

Value to append.

Returns:

distributionChannel

setDistributionChannel

void setDistributionChannel(ChannelResourceIdentifier distributionChannel)

Value to append.

Parameters:

distributionChannel - value to be set

of

static StoreAddDistributionChannelAction of()

factory method

Returns:

instance of StoreAddDistributionChannelAction

of

static StoreAddDistributionChannelAction of(StoreAddDistributionChannelAction template)

factory method to create a shallow copy StoreAddDistributionChannelAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StoreAddDistributionChannelAction copyDeep()

Specified by:

copyDeep in interface StoreUpdateAction

deepCopy

@Nullable
static StoreAddDistributionChannelAction deepCopy(@Nullable
 StoreAddDistributionChannelAction template)

factory method to create a deep copy of StoreAddDistributionChannelAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StoreAddDistributionChannelActionBuilder builder()

builder factory method for StoreAddDistributionChannelAction

Returns:

builder

builder

static StoreAddDistributionChannelActionBuilder builder(StoreAddDistributionChannelAction template)

create builder for StoreAddDistributionChannelAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStoreAddDistributionChannelAction

default <T> T withStoreAddDistributionChannelAction(Function<StoreAddDistributionChannelAction,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<StoreAddDistributionChannelAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference