Package com.commercetools.api.models.approval_rule

Interface ApprovalRuleSetDescriptionAction

All Superinterfaces:

ApprovalRuleUpdateAction

All Known Implementing Classes:

ApprovalRuleSetDescriptionActionImpl

public interface ApprovalRuleSetDescriptionAction
extends ApprovalRuleUpdateAction

Setting the description for an Approval Rule generates an ApprovalRuleDescriptionSet Message.

Example to create an instance using the builder pattern

     ApprovalRuleSetDescriptionAction approvalRuleSetDescriptionAction = ApprovalRuleSetDescriptionAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DESCRIPTION	discriminator value for ApprovalRuleSetDescriptionAction

Method Summary

Modifier and Type	Method	Description
static ApprovalRuleSetDescriptionActionBuilder	builder()	builder factory method for ApprovalRuleSetDescriptionAction
static ApprovalRuleSetDescriptionActionBuilder	builder(ApprovalRuleSetDescriptionAction template)	create builder for ApprovalRuleSetDescriptionAction instance
static ApprovalRuleSetDescriptionAction	deepCopy(ApprovalRuleSetDescriptionAction template)	factory method to create a deep copy of ApprovalRuleSetDescriptionAction
String	getDescription()	New description to set for the Approval Rule.
static ApprovalRuleSetDescriptionAction	of()	factory method
static ApprovalRuleSetDescriptionAction	of(ApprovalRuleSetDescriptionAction template)	factory method to create a shallow copy ApprovalRuleSetDescriptionAction
void	setDescription(String description)	New description to set for the Approval Rule.
static com.fasterxml.jackson.core.type.TypeReference<ApprovalRuleSetDescriptionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withApprovalRuleSetDescriptionAction(Function<ApprovalRuleSetDescriptionAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.approval_rule.ApprovalRuleUpdateAction

getAction, withApprovalRuleUpdateAction

Field Details

SET_DESCRIPTION

static final String SET_DESCRIPTION

discriminator value for ApprovalRuleSetDescriptionAction

See Also:

• Constant Field Values

Method Details

getDescription

String getDescription()

New description to set for the Approval Rule.

Returns:

description

setDescription

void setDescription(String description)

New description to set for the Approval Rule.

Parameters:

description - value to be set

of

static ApprovalRuleSetDescriptionAction of()

factory method

Returns:

instance of ApprovalRuleSetDescriptionAction

of

static ApprovalRuleSetDescriptionAction of(ApprovalRuleSetDescriptionAction template)

factory method to create a shallow copy ApprovalRuleSetDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ApprovalRuleSetDescriptionAction deepCopy(@Nullable
 ApprovalRuleSetDescriptionAction template)

factory method to create a deep copy of ApprovalRuleSetDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ApprovalRuleSetDescriptionActionBuilder builder()

builder factory method for ApprovalRuleSetDescriptionAction

Returns:

builder

builder

static ApprovalRuleSetDescriptionActionBuilder builder(ApprovalRuleSetDescriptionAction template)

create builder for ApprovalRuleSetDescriptionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withApprovalRuleSetDescriptionAction

default <T> T withApprovalRuleSetDescriptionAction(Function<ApprovalRuleSetDescriptionAction,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<ApprovalRuleSetDescriptionAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference