Package com.commercetools.api.models.cart

Interface CartSetLineItemTotalPriceAction

All Superinterfaces:
CartUpdateAction, ResourceUpdateAction<CartUpdateAction>
public interface CartSetLineItemTotalPriceAction extends CartUpdateAction

Sets the LineItem totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode. Cannot be used on Gift Line Items (see LineItemMode).

Example to create an instance using the builder pattern 

     CartSetLineItemTotalPriceAction cartSetLineItemTotalPriceAction = CartSetLineItemTotalPriceAction.builder()
             .build()

  • Field Details

    • SET_LINE_ITEM_TOTAL_PRICE

      static final String SET_LINE_ITEM_TOTAL_PRICE
      discriminator value for CartSetLineItemTotalPriceAction
      See Also:

  • 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 CartSetLineItemTotalPriceAction of()
      factory method
      Returns:
      instance of CartSetLineItemTotalPriceAction

    • of

      static CartSetLineItemTotalPriceAction of(CartSetLineItemTotalPriceAction template)
      factory method to create a shallow copy CartSetLineItemTotalPriceAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      CartSetLineItemTotalPriceAction copyDeep()
      Specified by:
      copyDeep in interface CartUpdateAction

    • deepCopy

      @Nullable static CartSetLineItemTotalPriceAction deepCopy(@Nullable CartSetLineItemTotalPriceAction template)
      factory method to create a deep copy of CartSetLineItemTotalPriceAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static CartSetLineItemTotalPriceActionBuilder builder()
      builder factory method for CartSetLineItemTotalPriceAction
      Returns:
      builder

    • builder

      static CartSetLineItemTotalPriceActionBuilder builder(CartSetLineItemTotalPriceAction template)
      create builder for CartSetLineItemTotalPriceAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withCartSetLineItemTotalPriceAction

      default <T> T withCartSetLineItemTotalPriceAction(Function<CartSetLineItemTotalPriceAction,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<CartSetLineItemTotalPriceAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference