Package com.commercetools.api.models.order_edit

Interface StagedOrderSetLineItemTotalPriceAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetLineItemTotalPriceAction
extends StagedOrderUpdateAction

Sets the LineItem totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode.

Example to create an instance using the builder pattern

     StagedOrderSetLineItemTotalPriceAction stagedOrderSetLineItemTotalPriceAction = StagedOrderSetLineItemTotalPriceAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_LINE_ITEM_TOTAL_PRICE	discriminator value for StagedOrderSetLineItemTotalPriceAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetLineItemTotalPriceActionBuilder	builder()	builder factory method for StagedOrderSetLineItemTotalPriceAction
static StagedOrderSetLineItemTotalPriceActionBuilder	builder(StagedOrderSetLineItemTotalPriceAction template)	create builder for StagedOrderSetLineItemTotalPriceAction instance
StagedOrderSetLineItemTotalPriceAction	copyDeep()
static StagedOrderSetLineItemTotalPriceAction	deepCopy(StagedOrderSetLineItemTotalPriceAction template)	factory method to create a deep copy of StagedOrderSetLineItemTotalPriceAction
@Valid ExternalLineItemTotalPrice	getExternalTotalPrice()	Value to set.
String	getLineItemId()	id of the LineItem to update.
String	getLineItemKey()	key of the LineItem to update.
static StagedOrderSetLineItemTotalPriceAction	of()	factory method
static StagedOrderSetLineItemTotalPriceAction	of(StagedOrderSetLineItemTotalPriceAction template)	factory method to create a shallow copy StagedOrderSetLineItemTotalPriceAction
void	setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)	Value to set.
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<StagedOrderSetLineItemTotalPriceAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetLineItemTotalPriceAction(Function<StagedOrderSetLineItemTotalPriceAction,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_TOTAL_PRICE

static final String SET_LINE_ITEM_TOTAL_PRICE

discriminator value for StagedOrderSetLineItemTotalPriceAction

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

getExternalTotalPrice

@Valid
@Valid ExternalLineItemTotalPrice getExternalTotalPrice()

Value to set. If externalTotalPrice is not given and the priceMode is ExternalTotal, the external price is unset and the priceMode is set to Platform.

Returns:

externalTotalPrice

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

setExternalTotalPrice

void setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)

Value to set. If externalTotalPrice is not given and the priceMode is ExternalTotal, the external price is unset and the priceMode is set to Platform.

Parameters:

externalTotalPrice - value to be set

of

static StagedOrderSetLineItemTotalPriceAction of()

factory method

Returns:

instance of StagedOrderSetLineItemTotalPriceAction

of

static StagedOrderSetLineItemTotalPriceAction of(StagedOrderSetLineItemTotalPriceAction template)

factory method to create a shallow copy StagedOrderSetLineItemTotalPriceAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetLineItemTotalPriceAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetLineItemTotalPriceAction deepCopy(@Nullable
 StagedOrderSetLineItemTotalPriceAction template)

factory method to create a deep copy of StagedOrderSetLineItemTotalPriceAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetLineItemTotalPriceActionBuilder builder()

builder factory method for StagedOrderSetLineItemTotalPriceAction

Returns:

builder

builder

static StagedOrderSetLineItemTotalPriceActionBuilder builder(StagedOrderSetLineItemTotalPriceAction template)

create builder for StagedOrderSetLineItemTotalPriceAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetLineItemTotalPriceAction

default <T> T withStagedOrderSetLineItemTotalPriceAction(Function<StagedOrderSetLineItemTotalPriceAction,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<StagedOrderSetLineItemTotalPriceAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference