Package com.commercetools.api.models.cart

Interface CartSetLineItemSupplyChannelAction

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

Performing this action has no impact on inventory that should be reserved.

Example to create an instance using the builder pattern 

     CartSetLineItemSupplyChannelAction cartSetLineItemSupplyChannelAction = CartSetLineItemSupplyChannelAction.builder()
             .build()

  • Field Details

    • SET_LINE_ITEM_SUPPLY_CHANNEL

      static final String SET_LINE_ITEM_SUPPLY_CHANNEL
      discriminator value for CartSetLineItemSupplyChannelAction
      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

    • getSupplyChannel

      @Valid @Valid ChannelResourceIdentifier getSupplyChannel()
      • If present, a Reference to the Channel is set for the LineItem specified by lineItemId.
      • If not present, the current Reference to a supply channel will be removed from the LineItem specified by lineItemId. The Channel must have the InventorySupply ChannelRoleEnum.
      Returns:
      supplyChannel

    • 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

    • setSupplyChannel

      void setSupplyChannel(ChannelResourceIdentifier supplyChannel)
      • If present, a Reference to the Channel is set for the LineItem specified by lineItemId.
      • If not present, the current Reference to a supply channel will be removed from the LineItem specified by lineItemId. The Channel must have the InventorySupply ChannelRoleEnum.
      Parameters:
      supplyChannel - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static CartSetLineItemSupplyChannelActionBuilder builder()
      builder factory method for CartSetLineItemSupplyChannelAction
      Returns:
      builder

    • builder

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

    • withCartSetLineItemSupplyChannelAction

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