Package com.commercetools.history.models.change

Interface SetReturnShipmentStateChange

All Superinterfaces:
Change
public interface SetReturnShipmentStateChange extends Change

Change triggered by the following update actions:

  • Set ReturnShipmentState on Orders.
  • Set ReturnShipmentState on Staged Orders.
Example to create an instance using the builder pattern 

     SetReturnShipmentStateChange setReturnShipmentStateChange = SetReturnShipmentStateChange.builder()
             .change("{change}")
             .previousValue(ReturnShipmentState.ADVISED)
             .nextValue(ReturnShipmentState.ADVISED)
             .build()

  • Field Details

    • SET_RETURN_SHIPMENT_STATE_CHANGE

      static final String SET_RETURN_SHIPMENT_STATE_CHANGE
      discriminator value for SetReturnShipmentStateChange
      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

    • getPreviousValue

      @NotNull @NotNull ReturnShipmentState getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @NotNull ReturnShipmentState getNextValue()

      Value after the change.

      Returns:
      nextValue

    • setChange

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

    • setPreviousValue

      void setPreviousValue(ReturnShipmentState previousValue)

      Value before the change.

      Parameters:
      previousValue - value to be set

    • setNextValue

      void setNextValue(ReturnShipmentState nextValue)

      Value after the change.

      Parameters:
      nextValue - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static SetReturnShipmentStateChangeBuilder builder()
      builder factory method for SetReturnShipmentStateChange
      Returns:
      builder

    • builder

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

    • withSetReturnShipmentStateChange

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