Package com.commercetools.history.models.change

Interface ChangeLabelChange

All Superinterfaces:
Change
public interface ChangeLabelChange extends Change

Change triggered by the following update actions:

  • Change AttributeDefinition Label on Product Types.
  • Change FieldDefinition Label on Types.
Example to create an instance using the builder pattern 

     ChangeLabelChange changeLabelChange = ChangeLabelChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .fieldName("{fieldName}")
             .attributeName("{attributeName}")
             .build()

  • Field Details

    • CHANGE_LABEL_CHANGE

      static final String CHANGE_LABEL_CHANGE
      discriminator value for ChangeLabelChange
      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 LocalizedString getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @Valid @NotNull @Valid LocalizedString getNextValue()

      Value after the change.

      Returns:
      nextValue

    • getFieldName

      @NotNull @NotNull String getFieldName()

      Name of the updated FieldDefinition; only present on changes to Types).

      Returns:
      fieldName

    • getAttributeName

      @NotNull @NotNull String getAttributeName()

      Name of the updated AttributeDefinition; only present on changes to Product Types.

      Returns:
      attributeName

    • setChange

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

    • setPreviousValue

      void setPreviousValue(LocalizedString previousValue)

      Value before the change.

      Parameters:
      previousValue - value to be set

    • setNextValue

      void setNextValue(LocalizedString nextValue)

      Value after the change.

      Parameters:
      nextValue - value to be set

    • setFieldName

      void setFieldName(String fieldName)

      Name of the updated FieldDefinition; only present on changes to Types).

      Parameters:
      fieldName - value to be set

    • setAttributeName

      void setAttributeName(String attributeName)

      Name of the updated AttributeDefinition; only present on changes to Product Types.

      Parameters:
      attributeName - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ChangeLabelChangeBuilder builder()
      builder factory method for ChangeLabelChange
      Returns:
      builder

    • builder

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

    • withChangeLabelChange

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