Package com.commercetools.history.models.change

Interface TransitionCustomLineItemStateChange

All Superinterfaces:
Change
public interface TransitionCustomLineItemStateChange extends Change

Change triggered by the following update actions:

  • Change the state of CustomLineItem according to allowed transitions on Orders.
  • Change the state of CustomLineItem according to allowed transitions on Staged Orders.
Example to create an instance using the builder pattern 

     TransitionCustomLineItemStateChange transitionCustomLineItemStateChange = TransitionCustomLineItemStateChange.builder()
             .change("{change}")
             .plusPreviousValue(previousValueBuilder -> previousValueBuilder)
             .plusNextValue(nextValueBuilder -> nextValueBuilder)
             .lineItemId("{lineItemId}")
             .stateId("{stateId}")
             .build()

  • Field Details

    • TRANSITION_CUSTOM_LINE_ITEM_STATE_CHANGE

      static final String TRANSITION_CUSTOM_LINE_ITEM_STATE_CHANGE
      discriminator value for TransitionCustomLineItemStateChange
      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 @Valid @NotNull @Valid List<ItemState> getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

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

      Value after the change.

      Returns:
      nextValue

    • getLineItemId

      @NotNull @NotNull String getLineItemId()

      id of the updated CustomLineItem.

      Returns:
      lineItemId

    • getStateId

      @NotNull @NotNull String getStateId()

      id of the State involved in the transition.

      Returns:
      stateId

    • setChange

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

    • setPreviousValue

      void setPreviousValue(ItemState... previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setPreviousValue

      void setPreviousValue(List<ItemState> previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setNextValue

      void setNextValue(ItemState... nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • setNextValue

      void setNextValue(List<ItemState> nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • setLineItemId

      void setLineItemId(String lineItemId)

      id of the updated CustomLineItem.

      Parameters:
      lineItemId - value to be set

    • setStateId

      void setStateId(String stateId)

      id of the State involved in the transition.

      Parameters:
      stateId - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static TransitionCustomLineItemStateChangeBuilder builder()
      builder factory method for TransitionCustomLineItemStateChange
      Returns:
      builder

    • builder

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

    • withTransitionCustomLineItemStateChange

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