Package com.commercetools.api.models.store

Interface StoreSetDistributionChannelsAction

All Superinterfaces:

ResourceUpdateAction<StoreUpdateAction>, StoreUpdateAction

public interface StoreSetDistributionChannelsAction
extends StoreUpdateAction

This update action produces the StoreDistributionChannelsChanged Message.

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

Example to create an instance using the builder pattern

     StoreSetDistributionChannelsAction storeSetDistributionChannelsAction = StoreSetDistributionChannelsAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DISTRIBUTION_CHANNELS	discriminator value for StoreSetDistributionChannelsAction

Method Summary

Modifier and Type	Method	Description
static StoreSetDistributionChannelsActionBuilder	builder()	builder factory method for StoreSetDistributionChannelsAction
static StoreSetDistributionChannelsActionBuilder	builder(StoreSetDistributionChannelsAction template)	create builder for StoreSetDistributionChannelsAction instance
StoreSetDistributionChannelsAction	copyDeep()
static StoreSetDistributionChannelsAction	deepCopy(StoreSetDistributionChannelsAction template)	factory method to create a deep copy of StoreSetDistributionChannelsAction
@Valid List<ChannelResourceIdentifier>	getDistributionChannels()	Value to set.
static StoreSetDistributionChannelsAction	of()	factory method
static StoreSetDistributionChannelsAction	of(StoreSetDistributionChannelsAction template)	factory method to create a shallow copy StoreSetDistributionChannelsAction
void	setDistributionChannels(ChannelResourceIdentifier... distributionChannels)	Value to set.
void	setDistributionChannels(List<ChannelResourceIdentifier> distributionChannels)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<StoreSetDistributionChannelsAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStoreSetDistributionChannelsAction(Function<StoreSetDistributionChannelsAction,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

SET_DISTRIBUTION_CHANNELS

static final String SET_DISTRIBUTION_CHANNELS

discriminator value for StoreSetDistributionChannelsAction

See Also:

• Constant Field Values

Method Details

getDistributionChannels

@Valid
@Valid List<ChannelResourceIdentifier> getDistributionChannels()

Value to set. If not defined, the Store's distributionChannels are unset.

Returns:

distributionChannels

setDistributionChannels

void setDistributionChannels(ChannelResourceIdentifier... distributionChannels)

Value to set. If not defined, the Store's distributionChannels are unset.

Parameters:

distributionChannels - values to be set

setDistributionChannels

void setDistributionChannels(List<ChannelResourceIdentifier> distributionChannels)

Value to set. If not defined, the Store's distributionChannels are unset.

Parameters:

distributionChannels - values to be set

of

static StoreSetDistributionChannelsAction of()

factory method

Returns:

instance of StoreSetDistributionChannelsAction

of

static StoreSetDistributionChannelsAction of(StoreSetDistributionChannelsAction template)

factory method to create a shallow copy StoreSetDistributionChannelsAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StoreSetDistributionChannelsAction copyDeep()

Specified by:

copyDeep in interface StoreUpdateAction

deepCopy

@Nullable
static StoreSetDistributionChannelsAction deepCopy(@Nullable
 StoreSetDistributionChannelsAction template)

factory method to create a deep copy of StoreSetDistributionChannelsAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StoreSetDistributionChannelsActionBuilder builder()

builder factory method for StoreSetDistributionChannelsAction

Returns:

builder

builder

static StoreSetDistributionChannelsActionBuilder builder(StoreSetDistributionChannelsAction template)

create builder for StoreSetDistributionChannelsAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStoreSetDistributionChannelsAction

default <T> T withStoreSetDistributionChannelsAction(Function<StoreSetDistributionChannelsAction,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<StoreSetDistributionChannelsAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference