Package com.commercetools.api.models.order_edit

Interface StagedOrderSetLineItemDistributionChannelAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderSetLineItemDistributionChannelActionImpl

public interface StagedOrderSetLineItemDistributionChannelAction
extends StagedOrderUpdateAction

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

Produces the OrderLineItemDistributionChannelSet Message.

Example to create an instance using the builder pattern

     StagedOrderSetLineItemDistributionChannelAction stagedOrderSetLineItemDistributionChannelAction = StagedOrderSetLineItemDistributionChannelAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetLineItemDistributionChannelActionBuilder	builder()	builder factory method for StagedOrderSetLineItemDistributionChannelAction
static StagedOrderSetLineItemDistributionChannelActionBuilder	builder(StagedOrderSetLineItemDistributionChannelAction template)	create builder for StagedOrderSetLineItemDistributionChannelAction instance
static StagedOrderSetLineItemDistributionChannelAction	deepCopy(StagedOrderSetLineItemDistributionChannelAction template)	factory method to create a deep copy of StagedOrderSetLineItemDistributionChannelAction
@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 StagedOrderSetLineItemDistributionChannelAction	of()	factory method
static StagedOrderSetLineItemDistributionChannelAction	of(StagedOrderSetLineItemDistributionChannelAction template)	factory method to create a shallow copy StagedOrderSetLineItemDistributionChannelAction
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<StagedOrderSetLineItemDistributionChannelAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetLineItemDistributionChannelAction(Function<StagedOrderSetLineItemDistributionChannelAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction

getAction, withStagedOrderUpdateAction

Field Details

SET_LINE_ITEM_DISTRIBUTION_CHANNEL

static final String SET_LINE_ITEM_DISTRIBUTION_CHANNEL

discriminator value for StagedOrderSetLineItemDistributionChannelAction

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 StagedOrderSetLineItemDistributionChannelAction of()

factory method

Returns:

instance of StagedOrderSetLineItemDistributionChannelAction

of

static StagedOrderSetLineItemDistributionChannelAction of(StagedOrderSetLineItemDistributionChannelAction template)

factory method to create a shallow copy StagedOrderSetLineItemDistributionChannelAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetLineItemDistributionChannelAction deepCopy(@Nullable
 StagedOrderSetLineItemDistributionChannelAction template)

factory method to create a deep copy of StagedOrderSetLineItemDistributionChannelAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetLineItemDistributionChannelActionBuilder builder()

builder factory method for StagedOrderSetLineItemDistributionChannelAction

Returns:

builder

builder

static StagedOrderSetLineItemDistributionChannelActionBuilder builder(StagedOrderSetLineItemDistributionChannelAction template)

create builder for StagedOrderSetLineItemDistributionChannelAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetLineItemDistributionChannelAction

default <T> T withStagedOrderSetLineItemDistributionChannelAction(Function<StagedOrderSetLineItemDistributionChannelAction,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<StagedOrderSetLineItemDistributionChannelAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference