Package com.commercetools.api.models.channel

Interface ChannelUpdate

All Superinterfaces:

ResourceUpdate<ChannelUpdate,ChannelUpdateAction,ChannelUpdateBuilder>

All Known Implementing Classes:

ChannelUpdateImpl

public interface ChannelUpdate
extends ResourceUpdate<ChannelUpdate,ChannelUpdateAction,ChannelUpdateBuilder>

ChannelUpdate Example to create an instance using the builder pattern

     ChannelUpdate channelUpdate = ChannelUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ChannelUpdateBuilder	builder()	builder factory method for ChannelUpdate
static ChannelUpdateBuilder	builder(ChannelUpdate template)	create builder for ChannelUpdate instance
static ChannelUpdate	deepCopy(ChannelUpdate template)	factory method to create a deep copy of ChannelUpdate
@NotNull @Valid List<ChannelUpdateAction>	getActions()	Update actions to be performed on the Channel.
@NotNull Long	getVersion()	Expected version of the Channel on which the changes should be applied.
static ChannelUpdate	of()	factory method
static ChannelUpdate	of(ChannelUpdate template)	factory method to create a shallow copy ChannelUpdate
void	setActions(ChannelUpdateAction... actions)	Update actions to be performed on the Channel.
void	setActions(List<ChannelUpdateAction> actions)	Update actions to be performed on the Channel.
void	setVersion(Long version)	Expected version of the Channel on which the changes should be applied.
static com.fasterxml.jackson.core.type.TypeReference<ChannelUpdate>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChannelUpdate(Function<ChannelUpdate,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.ResourceUpdate

get

Method Details

getVersion

@NotNull
@NotNull Long getVersion()

Expected version of the Channel on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error is returned.

Specified by:

getVersion in interface ResourceUpdate<ChannelUpdate,ChannelUpdateAction,ChannelUpdateBuilder>

Returns:

version

getActions

@NotNull
@Valid
@NotNull @Valid List<ChannelUpdateAction> getActions()

Update actions to be performed on the Channel.

Specified by:

getActions in interface ResourceUpdate<ChannelUpdate,ChannelUpdateAction,ChannelUpdateBuilder>

Returns:

actions

setVersion

void setVersion(Long version)

Expected version of the Channel on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error is returned.

Specified by:

setVersion in interface ResourceUpdate<ChannelUpdate,ChannelUpdateAction,ChannelUpdateBuilder>

Parameters:

version - value to be set

setActions

void setActions(ChannelUpdateAction... actions)

Update actions to be performed on the Channel.

Parameters:

actions - values to be set

setActions

void setActions(List<ChannelUpdateAction> actions)

Update actions to be performed on the Channel.

Specified by:

setActions in interface ResourceUpdate<ChannelUpdate,ChannelUpdateAction,ChannelUpdateBuilder>

Parameters:

actions - values to be set

of

static ChannelUpdate of()

factory method

Returns:

instance of ChannelUpdate

of

static ChannelUpdate of(ChannelUpdate template)

factory method to create a shallow copy ChannelUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChannelUpdate deepCopy(@Nullable
 ChannelUpdate template)

factory method to create a deep copy of ChannelUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChannelUpdateBuilder builder()

builder factory method for ChannelUpdate

Returns:

builder

builder

static ChannelUpdateBuilder builder(ChannelUpdate template)

create builder for ChannelUpdate instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChannelUpdate

default <T> T withChannelUpdate(Function<ChannelUpdate,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<ChannelUpdate> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference