Package com.commercetools.api.models.cart

Interface CartSetLineItemDistributionChannelAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

public interface CartSetLineItemDistributionChannelAction
extends CartUpdateAction

Setting a distribution channel for a LineItem can lead to an updated price as described in Line Item price selection.

Example to create an instance using the builder pattern

     CartSetLineItemDistributionChannelAction cartSetLineItemDistributionChannelAction = CartSetLineItemDistributionChannelAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_LINE_ITEM_DISTRIBUTION_CHANNEL	discriminator value for CartSetLineItemDistributionChannelAction

Method Summary

Modifier and Type	Method	Description
static CartSetLineItemDistributionChannelActionBuilder	builder()	builder factory method for CartSetLineItemDistributionChannelAction
static CartSetLineItemDistributionChannelActionBuilder	builder(CartSetLineItemDistributionChannelAction template)	create builder for CartSetLineItemDistributionChannelAction instance
CartSetLineItemDistributionChannelAction	copyDeep()
static CartSetLineItemDistributionChannelAction	deepCopy(CartSetLineItemDistributionChannelAction template)	factory method to create a deep copy of CartSetLineItemDistributionChannelAction
@Valid ChannelResourceIdentifier	getDistributionChannel()	If present, a Reference to the Channel is set for the LineItem specified by lineItemId. If not present, the current Reference to a distribution channel is removed from the LineItem specified by lineItemId.
String	getLineItemId()	id of the LineItem to update.
String	getLineItemKey()	key of the LineItem to update.
static CartSetLineItemDistributionChannelAction	of()	factory method
static CartSetLineItemDistributionChannelAction	of(CartSetLineItemDistributionChannelAction template)	factory method to create a shallow copy CartSetLineItemDistributionChannelAction
void	setDistributionChannel(ChannelResourceIdentifier distributionChannel)	If present, a Reference to the Channel is set for the LineItem specified by lineItemId. If not present, the current Reference to a distribution channel is removed from the LineItem specified by lineItemId.
void	setLineItemId(String lineItemId)	id of the LineItem to update.
void	setLineItemKey(String lineItemKey)	key of the LineItem to update.
static com.fasterxml.jackson.core.type.TypeReference<CartSetLineItemDistributionChannelAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetLineItemDistributionChannelAction(Function<CartSetLineItemDistributionChannelAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.cart.CartUpdateAction

getAction, withCartUpdateAction

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

get

Field Details

SET_LINE_ITEM_DISTRIBUTION_CHANNEL

static final String SET_LINE_ITEM_DISTRIBUTION_CHANNEL

discriminator value for CartSetLineItemDistributionChannelAction

See Also:

• Constant Field Values

Method Details

getLineItemId

String getLineItemId()

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemId

getLineItemKey

String getLineItemKey()

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemKey

getDistributionChannel

@Valid
@Valid ChannelResourceIdentifier getDistributionChannel()

• If present, a Reference to the Channel is set for the LineItem specified by lineItemId.
• If not present, the current Reference to a distribution channel is removed from the LineItem specified by lineItemId. The Channel must have the ProductDistribution ChannelRoleEnum.

Returns:

distributionChannel

setLineItemId

void setLineItemId(String lineItemId)

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemId - value to be set

setLineItemKey

void setLineItemKey(String lineItemKey)

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemKey - value to be set

setDistributionChannel

void setDistributionChannel(ChannelResourceIdentifier distributionChannel)

• If present, a Reference to the Channel is set for the LineItem specified by lineItemId.
• If not present, the current Reference to a distribution channel is removed from the LineItem specified by lineItemId. The Channel must have the ProductDistribution ChannelRoleEnum.

Parameters:

distributionChannel - value to be set

of

static CartSetLineItemDistributionChannelAction of()

factory method

Returns:

instance of CartSetLineItemDistributionChannelAction

of

static CartSetLineItemDistributionChannelAction of(CartSetLineItemDistributionChannelAction template)

factory method to create a shallow copy CartSetLineItemDistributionChannelAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartSetLineItemDistributionChannelAction copyDeep()

Specified by:

copyDeep in interface CartUpdateAction

deepCopy

@Nullable
static CartSetLineItemDistributionChannelAction deepCopy(@Nullable
 CartSetLineItemDistributionChannelAction template)

factory method to create a deep copy of CartSetLineItemDistributionChannelAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetLineItemDistributionChannelActionBuilder builder()

builder factory method for CartSetLineItemDistributionChannelAction

Returns:

builder

builder

static CartSetLineItemDistributionChannelActionBuilder builder(CartSetLineItemDistributionChannelAction template)

create builder for CartSetLineItemDistributionChannelAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetLineItemDistributionChannelAction

default <T> T withCartSetLineItemDistributionChannelAction(Function<CartSetLineItemDistributionChannelAction,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<CartSetLineItemDistributionChannelAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference