Package com.commercetools.history.models.change

Interface SetPermissionsChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetPermissionsChangeImpl

public interface SetPermissionsChange
extends Change

Change triggered by the Set Permissions, Add Permission, and Remove Permission update actions.

Example to create an instance using the builder pattern

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_PERMISSIONS_CHANGE	discriminator value for SetPermissionsChange

Method Summary

Modifier and Type	Method	Description
static SetPermissionsChangeBuilder	builder()	builder factory method for SetPermissionsChange
static SetPermissionsChangeBuilder	builder(SetPermissionsChange template)	create builder for SetPermissionsChange instance
static SetPermissionsChange	deepCopy(SetPermissionsChange template)	factory method to create a deep copy of SetPermissionsChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull List<Permission>	getNextValue()	Value after the change.
@NotNull List<Permission>	getPreviousValue()	Value before the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
static SetPermissionsChange	of()	factory method
static SetPermissionsChange	of(SetPermissionsChange template)	factory method to create a shallow copy SetPermissionsChange
void	setChange(String change)	set change
void	setNextValue(Permission... nextValue)	Value after the change.
void	setNextValue(List<Permission> nextValue)	Value after the change.
void	setPreviousValue(Permission... previousValue)	Value before the change.
void	setPreviousValue(List<Permission> previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<SetPermissionsChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetPermissionsChange(Function<SetPermissionsChange,T> helper)	accessor map function

Methods inherited from interface com.commercetools.history.models.change.Change

withChange

Field Details

SET_PERMISSIONS_CHANGE

static final String SET_PERMISSIONS_CHANGE

discriminator value for SetPermissionsChange

See Also:

• Constant Field Values

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<Permission> getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

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

Value before the change.

Parameters:

previousValue - values to be set

setPreviousValue

void setPreviousValue(List<Permission> previousValue)

Value before the change.

Parameters:

previousValue - values to be set

setNextValue

void setNextValue(Permission... nextValue)

Value after the change.

Parameters:

nextValue - values to be set

setNextValue

void setNextValue(List<Permission> nextValue)

Value after the change.

Parameters:

nextValue - values to be set

of

static SetPermissionsChange of()

factory method

Returns:

instance of SetPermissionsChange

of

static SetPermissionsChange of(SetPermissionsChange template)

factory method to create a shallow copy SetPermissionsChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetPermissionsChange deepCopy(@Nullable
 SetPermissionsChange template)

factory method to create a deep copy of SetPermissionsChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetPermissionsChangeBuilder builder()

builder factory method for SetPermissionsChange

Returns:

builder

builder

static SetPermissionsChangeBuilder builder(SetPermissionsChange template)

create builder for SetPermissionsChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetPermissionsChange

default <T> T withSetPermissionsChange(Function<SetPermissionsChange,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<SetPermissionsChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference