Package com.commercetools.api.models.order_edit

Interface StagedOrderSetParcelItemsAction

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

Produces the ParcelItemsUpdated Message.

Example to create an instance using the builder pattern 

     StagedOrderSetParcelItemsAction stagedOrderSetParcelItemsAction = StagedOrderSetParcelItemsAction.builder()
             .plusItems(itemsBuilder -> itemsBuilder)
             .build()

  • Field Details

    • SET_PARCEL_ITEMS

      static final String SET_PARCEL_ITEMS
      discriminator value for StagedOrderSetParcelItemsAction
      See Also:

  • Method Details

    • getParcelId

      String getParcelId()

      id of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Returns:
      parcelId

    • getParcelKey

      String getParcelKey()

      key of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Returns:
      parcelKey

    • getItems

      @NotNull @Valid @NotNull @Valid List<DeliveryItem> getItems()

      Value to set. If empty, any existing value will be removed.

      Returns:
      items

    • setParcelId

      void setParcelId(String parcelId)

      id of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Parameters:
      parcelId - value to be set

    • setParcelKey

      void setParcelKey(String parcelKey)

      key of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Parameters:
      parcelKey - value to be set

    • setItems

      void setItems(DeliveryItem... items)

      Value to set. If empty, any existing value will be removed.

      Parameters:
      items - values to be set

    • setItems

      void setItems(List<DeliveryItem> items)

      Value to set. If empty, any existing value will be removed.

      Parameters:
      items - values to be set

    • of

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

    • of

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

    • copyDeep

      StagedOrderSetParcelItemsAction copyDeep()
      Specified by:
      copyDeep in interface StagedOrderUpdateAction

    • deepCopy

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

    • builder

      static StagedOrderSetParcelItemsActionBuilder builder()
      builder factory method for StagedOrderSetParcelItemsAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetParcelItemsAction

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