Package com.commercetools.history.models.change

Interface AddParcelToDeliveryChange

All Superinterfaces:
Change
public interface AddParcelToDeliveryChange extends Change

Change triggered by the following update actions:

  • Add Parcel on Orders.
  • Add Parcel on Staged Orders.
Example to create an instance using the builder pattern 

     AddParcelToDeliveryChange addParcelToDeliveryChange = AddParcelToDeliveryChange.builder()
             .change("{change}")
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .deliveryId("{deliveryId}")
             .build()

  • Field Details

    • ADD_PARCEL_TO_DELIVERY_CHANGE

      static final String ADD_PARCEL_TO_DELIVERY_CHANGE
      discriminator value for AddParcelToDeliveryChange
      See Also:

  • Method Details

    • getType

      @NotNull @NotNull String getType()
      Description copied from interface: Change

      Unique discriminator value to reliably deserialize the data type.

      Specified by:
      getType in interface Change
      Returns:
      type

    • getChange

      @NotNull @NotNull String getChange()
      Description copied from interface: Change

      Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

      Records can be filtered by this value using the changes query parameter.

      Specified by:
      getChange in interface Change
      Returns:
      change

    • getNextValue

      @NotNull @Valid @NotNull @Valid Parcel getNextValue()

      Value after the change.

      Returns:
      nextValue

    • getDeliveryId

      @NotNull @NotNull String getDeliveryId()

      id of the Delivery to which the Parcel was added.

      Returns:
      deliveryId

    • setChange

      void setChange(String change)
      set change
      Specified by:
      setChange in interface Change
      Parameters:
      change - value to be set

    • setNextValue

      void setNextValue(Parcel nextValue)

      Value after the change.

      Parameters:
      nextValue - value to be set

    • setDeliveryId

      void setDeliveryId(String deliveryId)

      id of the Delivery to which the Parcel was added.

      Parameters:
      deliveryId - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static AddParcelToDeliveryChangeBuilder builder()
      builder factory method for AddParcelToDeliveryChange
      Returns:
      builder

    • builder

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

    • withAddParcelToDeliveryChange

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