Package com.commercetools.history.models.change

Interface SetChannelRolesChange

All Superinterfaces:
Change
public interface SetChannelRolesChange extends Change

Change triggered by the Set Roles update action.

Example to create an instance using the builder pattern 

     SetChannelRolesChange setChannelRolesChange = SetChannelRolesChange.builder()
             .change("{change}")
             .plusPreviousValue(previousValueBuilder -> previousValueBuilder)
             .plusNextValue(nextValueBuilder -> nextValueBuilder)
             .build()

  • Field Details

    • SET_CHANNEL_ROLES_CHANGE

      static final String SET_CHANNEL_ROLES_CHANGE
      discriminator value for SetChannelRolesChange
      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 List<ChannelRoleEnum> getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @NotNull List<ChannelRoleEnum> 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(ChannelRoleEnum... previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setPreviousValue

      void setPreviousValue(List<ChannelRoleEnum> previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setNextValue

      void setNextValue(ChannelRoleEnum... nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • setNextValue

      void setNextValue(List<ChannelRoleEnum> nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • of

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

    • of

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

    • copyDeep

      SetChannelRolesChange copyDeep()
      Specified by:
      copyDeep in interface Change

    • deepCopy

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

    • builder

      static SetChannelRolesChangeBuilder builder()
      builder factory method for SetChannelRolesChange
      Returns:
      builder

    • builder

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

    • withSetChannelRolesChange

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