Package com.commercetools.api.models.order_edit

Interface StagedOrderSetLineItemPriceAction

All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction
public interface StagedOrderSetLineItemPriceAction extends StagedOrderUpdateAction

Sets the LineItem price and changes the priceMode to ExternalPrice LineItemPriceMode.

Example to create an instance using the builder pattern 

     StagedOrderSetLineItemPriceAction stagedOrderSetLineItemPriceAction = StagedOrderSetLineItemPriceAction.builder()
             .build()

  • Field Details

    • SET_LINE_ITEM_PRICE

      static final String SET_LINE_ITEM_PRICE
      discriminator value for StagedOrderSetLineItemPriceAction
      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

    • getExternalPrice

      @Valid @Valid Money getExternalPrice()

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

      To set the money value in high precision, use HighPrecisionMoneyDraft.

      Returns:
      externalPrice

    • 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

    • setExternalPrice

      void setExternalPrice(Money externalPrice)

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

      To set the money value in high precision, use HighPrecisionMoneyDraft.

      Parameters:
      externalPrice - value to be set

    • of

      static StagedOrderSetLineItemPriceAction of()
      factory method
      Returns:
      instance of StagedOrderSetLineItemPriceAction

    • of

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

    • copyDeep

      StagedOrderSetLineItemPriceAction copyDeep()
      Specified by:
      copyDeep in interface StagedOrderUpdateAction

    • deepCopy

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

    • builder

      static StagedOrderSetLineItemPriceActionBuilder builder()
      builder factory method for StagedOrderSetLineItemPriceAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetLineItemPriceAction

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