Package com.commercetools.history.models.change

Interface SetAncestorsChange

All Superinterfaces:
Change
public interface SetAncestorsChange extends Change

This change is initiated by background processes after the Change Parent update action is performed.

Example to create an instance using the builder pattern 

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

  • Field Details

    • SET_ANCESTORS_CHANGE

      static final String SET_ANCESTORS_CHANGE
      discriminator value for SetAncestorsChange
      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<Reference> getAddedItems()

      Elements added to the array.

      Returns:
      addedItems

    • getRemovedItems

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

      Elements removed from the array.

      Returns:
      removedItems

    • getPreviousValue

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

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @Valid @NotNull @Valid List<Reference> 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(Reference... addedItems)

      Elements added to the array.

      Parameters:
      addedItems - values to be set

    • setAddedItems

      void setAddedItems(List<Reference> addedItems)

      Elements added to the array.

      Parameters:
      addedItems - values to be set

    • setRemovedItems

      void setRemovedItems(Reference... removedItems)

      Elements removed from the array.

      Parameters:
      removedItems - values to be set

    • setRemovedItems

      void setRemovedItems(List<Reference> removedItems)

      Elements removed from the array.

      Parameters:
      removedItems - values to be set

    • setPreviousValue

      void setPreviousValue(Reference... previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setPreviousValue

      void setPreviousValue(List<Reference> previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setNextValue

      void setNextValue(Reference... nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • setNextValue

      void setNextValue(List<Reference> nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • of

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

    • of

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

    • copyDeep

      SetAncestorsChange copyDeep()
      Specified by:
      copyDeep in interface Change

    • deepCopy

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

    • builder

      static SetAncestorsChangeBuilder builder()
      builder factory method for SetAncestorsChange
      Returns:
      builder

    • builder

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

    • withSetAncestorsChange

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