Package com.commercetools.history.models.change

Interface SetAssociatesChange

All Superinterfaces:
Change
public interface SetAssociatesChange extends Change

Change triggered by the Set Associates update action.

Example to create an instance using the builder pattern 

     SetAssociatesChange setAssociatesChange = SetAssociatesChange.builder()
             .change("{change}")
             .plusAddedItems(addedItemsBuilder -> addedItemsBuilder)
             .plusRemovedItems(removedItemsBuilder -> removedItemsBuilder)
             .plusPreviousValue(previousValueBuilder -> previousValueBuilder)
             .plusNextValue(nextValueBuilder -> nextValueBuilder)
             .build()

  • Field Details

    • SET_ASSOCIATES_CHANGE

      static final String SET_ASSOCIATES_CHANGE
      discriminator value for SetAssociatesChange
      See Also:

  • Method Details

    • 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

    • 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

    • getAddedItems

      @NotNull @Valid @NotNull @Valid List<Associate> getAddedItems()

      Elements added to the array.

      Returns:
      addedItems

    • getRemovedItems

      @NotNull @Valid @NotNull @Valid List<Associate> getRemovedItems()

      Elements removed from the array.

      Returns:
      removedItems

    • getPreviousValue

      @NotNull @Valid @NotNull @Valid List<Associate> getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @Valid @NotNull @Valid List<Associate> 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

    • setAddedItems

      void setAddedItems(Associate... addedItems)

      Elements added to the array.

      Parameters:
      addedItems - values to be set

    • setAddedItems

      void setAddedItems(List<Associate> addedItems)

      Elements added to the array.

      Parameters:
      addedItems - values to be set

    • setRemovedItems

      void setRemovedItems(Associate... removedItems)

      Elements removed from the array.

      Parameters:
      removedItems - values to be set

    • setRemovedItems

      void setRemovedItems(List<Associate> removedItems)

      Elements removed from the array.

      Parameters:
      removedItems - values to be set

    • setPreviousValue

      void setPreviousValue(Associate... previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setPreviousValue

      void setPreviousValue(List<Associate> previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setNextValue

      void setNextValue(Associate... nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • setNextValue

      void setNextValue(List<Associate> nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • of

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

    • of

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

    • copyDeep

      SetAssociatesChange copyDeep()
      Specified by:
      copyDeep in interface Change

    • deepCopy

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

    • builder

      static SetAssociatesChangeBuilder builder()
      builder factory method for SetAssociatesChange
      Returns:
      builder

    • builder

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

    • withSetAssociatesChange

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