Package com.commercetools.api.models.order_edit

Class StagedOrderChangeLineItemQuantityActionImpl

java.lang.Object

com.commercetools.api.models.order_edit.StagedOrderChangeLineItemQuantityActionImpl

All Implemented Interfaces:

StagedOrderChangeLineItemQuantityAction, StagedOrderUpdateAction, ResourceUpdateAction<StagedOrderUpdateAction>, io.vrap.rmf.base.client.ModelBase

public class StagedOrderChangeLineItemQuantityActionImpl
extends Object
implements StagedOrderChangeLineItemQuantityAction, io.vrap.rmf.base.client.ModelBase

When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details. Since it is not possible for the API to infer how the overall change in the Line Item quantity should be distributed over the sub-quantities, the shippingDetails field is kept in its current state to avoid data loss.

To change the Line Item quantity and shipping details together, use this update action in combination with the Set LineItem ShippingDetails update action in a single Order update command.

The LineItem price is updated as described in LineItem Price selection.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Field Summary

Fields inherited from interface com.commercetools.api.models.order_edit.StagedOrderChangeLineItemQuantityAction

CHANGE_LINE_ITEM_QUANTITY

Constructor Summary

Constructors

Constructor	Description
StagedOrderChangeLineItemQuantityActionImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getAction()
Money	getExternalPrice()	Sets the LineItem price to the given value when changing the quantity of a Line Item with the ExternalPrice LineItemPriceMode.
ExternalLineItemTotalPrice	getExternalTotalPrice()	Sets the LineItem price and totalPrice to the given value when changing the quantity of a Line Item with the ExternalTotal LineItemPriceMode.
String	getLineItemId()	id of the LineItem to update.
String	getLineItemKey()	key of the LineItem to update.
Long	getQuantity()	New value to set.
int	hashCode()
void	setExternalPrice(Money externalPrice)	Sets the LineItem price to the given value when changing the quantity of a Line Item with the ExternalPrice LineItemPriceMode.
void	setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)	Sets the LineItem price and totalPrice to the given value when changing the quantity of a Line Item with the ExternalTotal LineItemPriceMode.
void	setLineItemId(String lineItemId)	id of the LineItem to update.
void	setLineItemKey(String lineItemKey)	key of the LineItem to update.
void	setQuantity(Long quantity)	New value to set.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

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

get

Methods inherited from interface com.commercetools.api.models.order_edit.StagedOrderChangeLineItemQuantityAction

withStagedOrderChangeLineItemQuantityAction

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

withStagedOrderUpdateAction

Constructor Details

StagedOrderChangeLineItemQuantityActionImpl

public StagedOrderChangeLineItemQuantityActionImpl()

create empty instance

Method Details

getAction

public String getAction()

Specified by:

getAction in interface ResourceUpdateAction<StagedOrderUpdateAction>

Specified by:

getAction in interface StagedOrderUpdateAction

Returns:

action

getLineItemId

public String getLineItemId()

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

Specified by:

getLineItemId in interface StagedOrderChangeLineItemQuantityAction

Returns:

lineItemId

getLineItemKey

public String getLineItemKey()

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

Specified by:

getLineItemKey in interface StagedOrderChangeLineItemQuantityAction

Returns:

lineItemKey

getQuantity

public Long getQuantity()

New value to set. If 0, the LineItem is removed from the Order.

Specified by:

getQuantity in interface StagedOrderChangeLineItemQuantityAction

Returns:

quantity

getExternalPrice

public Money getExternalPrice()

Sets the LineItem price to the given value when changing the quantity of a Line Item with the ExternalPrice LineItemPriceMode.

The LineItem price is updated as described in LineItem Price selection.

Specified by:

getExternalPrice in interface StagedOrderChangeLineItemQuantityAction

Returns:

externalPrice

getExternalTotalPrice

public ExternalLineItemTotalPrice getExternalTotalPrice()

Sets the LineItem price and totalPrice to the given value when changing the quantity of a Line Item with the ExternalTotal LineItemPriceMode.

Specified by:

getExternalTotalPrice in interface StagedOrderChangeLineItemQuantityAction

Returns:

externalTotalPrice

setLineItemId

public void setLineItemId(String lineItemId)

Description copied from interface: StagedOrderChangeLineItemQuantityAction

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

Specified by:

setLineItemId in interface StagedOrderChangeLineItemQuantityAction

Parameters:

lineItemId - value to be set

setLineItemKey

public void setLineItemKey(String lineItemKey)

Description copied from interface: StagedOrderChangeLineItemQuantityAction

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

Specified by:

setLineItemKey in interface StagedOrderChangeLineItemQuantityAction

Parameters:

lineItemKey - value to be set

setQuantity

public void setQuantity(Long quantity)

Description copied from interface: StagedOrderChangeLineItemQuantityAction

New value to set. If 0, the LineItem is removed from the Order.

Specified by:

setQuantity in interface StagedOrderChangeLineItemQuantityAction

Parameters:

quantity - value to be set

setExternalPrice

public void setExternalPrice(Money externalPrice)

Description copied from interface: StagedOrderChangeLineItemQuantityAction

Sets the LineItem price to the given value when changing the quantity of a Line Item with the ExternalPrice LineItemPriceMode.

The LineItem price is updated as described in LineItem Price selection.

Specified by:

setExternalPrice in interface StagedOrderChangeLineItemQuantityAction

Parameters:

externalPrice - value to be set

setExternalTotalPrice

public void setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)

Description copied from interface: StagedOrderChangeLineItemQuantityAction

Sets the LineItem price and totalPrice to the given value when changing the quantity of a Line Item with the ExternalTotal LineItemPriceMode.

Specified by:

setExternalTotalPrice in interface StagedOrderChangeLineItemQuantityAction

Parameters:

externalTotalPrice - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object