Package com.commercetools.api.models.order

Interface OrderImportLineItemStateAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>
public interface OrderImportLineItemStateAction extends OrderUpdateAction

The import of States does not follow any predefined rules and should be only used if no transitions are defined. The quantity in the ItemStates must match the sum of all Line Items states' quantities.

Example to create an instance using the builder pattern 

     OrderImportLineItemStateAction orderImportLineItemStateAction = OrderImportLineItemStateAction.builder()
             .plusState(stateBuilder -> stateBuilder)
             .build()

  • Field Details

    • IMPORT_LINE_ITEM_STATE

      static final String IMPORT_LINE_ITEM_STATE
      discriminator value for OrderImportLineItemStateAction
      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

    • getState

      @NotNull @Valid @NotNull @Valid List<ItemState> getState()

      New status of the Line Items.

      Returns:
      state

    • 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

    • setState

      void setState(ItemState... state)

      New status of the Line Items.

      Parameters:
      state - values to be set

    • setState

      void setState(List<ItemState> state)

      New status of the Line Items.

      Parameters:
      state - values to be set

    • of

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

    • of

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

    • copyDeep

      OrderImportLineItemStateAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

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

    • builder

      static OrderImportLineItemStateActionBuilder builder()
      builder factory method for OrderImportLineItemStateAction
      Returns:
      builder

    • builder

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

    • withOrderImportLineItemStateAction

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