Package com.commercetools.api.models.approval_flow

Interface ApprovalFlowRejectAction

All Superinterfaces:

ApprovalFlowUpdateAction

public interface ApprovalFlowRejectAction
extends ApprovalFlowUpdateAction

This update action allows an Associate to reject an Approval Flow, setting its status to Rejected. The process takes into account all Associate Roles held by the Associate, aligning with the matched Approval Rules and their respective approver hierarchies. Even a single rejection in the process will result in the rejection of the entire Approval Flow.

An Associate is eligible to reject only if their roles are within tiers of the Approval Rule hierarchy that are yet to be rejected. An Associate may alter a prior approval into a rejection.

Example to create an instance using the builder pattern

     ApprovalFlowRejectAction approvalFlowRejectAction = ApprovalFlowRejectAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REJECT	discriminator value for ApprovalFlowRejectAction

Method Summary

Modifier and Type	Method	Description
static ApprovalFlowRejectActionBuilder	builder()	builder factory method for ApprovalFlowRejectAction
static ApprovalFlowRejectActionBuilder	builder(ApprovalFlowRejectAction template)	create builder for ApprovalFlowRejectAction instance
ApprovalFlowRejectAction	copyDeep()
static ApprovalFlowRejectAction	deepCopy(ApprovalFlowRejectAction template)	factory method to create a deep copy of ApprovalFlowRejectAction
String	getReason()	The reason for the rejection of the Approval Flow.
static ApprovalFlowRejectAction	of()	factory method
static ApprovalFlowRejectAction	of(ApprovalFlowRejectAction template)	factory method to create a shallow copy ApprovalFlowRejectAction
void	setReason(String reason)	The reason for the rejection of the Approval Flow.
static com.fasterxml.jackson.core.type.TypeReference<ApprovalFlowRejectAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withApprovalFlowRejectAction(Function<ApprovalFlowRejectAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.approval_flow.ApprovalFlowUpdateAction

getAction, withApprovalFlowUpdateAction

Field Details

REJECT

static final String REJECT

discriminator value for ApprovalFlowRejectAction

See Also:

• Constant Field Values

Method Details

getReason

String getReason()

The reason for the rejection of the Approval Flow.

Returns:

reason

setReason

void setReason(String reason)

The reason for the rejection of the Approval Flow.

Parameters:

reason - value to be set

of

static ApprovalFlowRejectAction of()

factory method

Returns:

instance of ApprovalFlowRejectAction

of

static ApprovalFlowRejectAction of(ApprovalFlowRejectAction template)

factory method to create a shallow copy ApprovalFlowRejectAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ApprovalFlowRejectAction copyDeep()

Specified by:

copyDeep in interface ApprovalFlowUpdateAction

deepCopy

@Nullable
static ApprovalFlowRejectAction deepCopy(@Nullable
 ApprovalFlowRejectAction template)

factory method to create a deep copy of ApprovalFlowRejectAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ApprovalFlowRejectActionBuilder builder()

builder factory method for ApprovalFlowRejectAction

Returns:

builder

builder

static ApprovalFlowRejectActionBuilder builder(ApprovalFlowRejectAction template)

create builder for ApprovalFlowRejectAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withApprovalFlowRejectAction

default <T> T withApprovalFlowRejectAction(Function<ApprovalFlowRejectAction,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<ApprovalFlowRejectAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference