Package com.commercetools.api.models.store

Interface StoreAddSupplyChannelAction

All Superinterfaces:

ResourceUpdateAction<StoreUpdateAction>, StoreUpdateAction

public interface StoreAddSupplyChannelAction
extends StoreUpdateAction

This action has no effect if a given supply channel is already present in a Store.

Adding a supply channel produces the StoreSupplyChannelsChanged Message.

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

Example to create an instance using the builder pattern

     StoreAddSupplyChannelAction storeAddSupplyChannelAction = StoreAddSupplyChannelAction.builder()
             .supplyChannel(supplyChannelBuilder -> supplyChannelBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_SUPPLY_CHANNEL	discriminator value for StoreAddSupplyChannelAction

Method Summary

Modifier and Type	Method	Description
static StoreAddSupplyChannelActionBuilder	builder()	builder factory method for StoreAddSupplyChannelAction
static StoreAddSupplyChannelActionBuilder	builder(StoreAddSupplyChannelAction template)	create builder for StoreAddSupplyChannelAction instance
static StoreAddSupplyChannelAction	deepCopy(StoreAddSupplyChannelAction template)	factory method to create a deep copy of StoreAddSupplyChannelAction
@NotNull @Valid ChannelResourceIdentifier	getSupplyChannel()	Value to append.
static StoreAddSupplyChannelAction	of()	factory method
static StoreAddSupplyChannelAction	of(StoreAddSupplyChannelAction template)	factory method to create a shallow copy StoreAddSupplyChannelAction
void	setSupplyChannel(ChannelResourceIdentifier supplyChannel)	Value to append.
static com.fasterxml.jackson.core.type.TypeReference<StoreAddSupplyChannelAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStoreAddSupplyChannelAction(Function<StoreAddSupplyChannelAction,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_SUPPLY_CHANNEL

static final String ADD_SUPPLY_CHANNEL

discriminator value for StoreAddSupplyChannelAction

See Also:

• Constant Field Values

Method Details

getSupplyChannel

@NotNull
@Valid
@NotNull @Valid ChannelResourceIdentifier getSupplyChannel()

Value to append.

Returns:

supplyChannel

setSupplyChannel

void setSupplyChannel(ChannelResourceIdentifier supplyChannel)

Value to append.

Parameters:

supplyChannel - value to be set

of

static StoreAddSupplyChannelAction of()

factory method

Returns:

instance of StoreAddSupplyChannelAction

of

static StoreAddSupplyChannelAction of(StoreAddSupplyChannelAction template)

factory method to create a shallow copy StoreAddSupplyChannelAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StoreAddSupplyChannelAction deepCopy(@Nullable
 StoreAddSupplyChannelAction template)

factory method to create a deep copy of StoreAddSupplyChannelAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StoreAddSupplyChannelActionBuilder builder()

builder factory method for StoreAddSupplyChannelAction

Returns:

builder

builder

static StoreAddSupplyChannelActionBuilder builder(StoreAddSupplyChannelAction template)

create builder for StoreAddSupplyChannelAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStoreAddSupplyChannelAction

default <T> T withStoreAddSupplyChannelAction(Function<StoreAddSupplyChannelAction,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<StoreAddSupplyChannelAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference