Package com.commercetools.api.models.message

Interface ApprovalFlowCompletedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface ApprovalFlowCompletedMessagePayload
extends MessagePayload

Generated after an Approval Flow is completed and reaches a final status.

Example to create an instance using the builder pattern

     ApprovalFlowCompletedMessagePayload approvalFlowCompletedMessagePayload = ApprovalFlowCompletedMessagePayload.builder()
             .status(ApprovalFlowStatus.PENDING)
             .order(orderBuilder -> orderBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPROVAL_FLOW_COMPLETED	discriminator value for ApprovalFlowCompletedMessagePayload

Method Summary

Modifier and Type	Method	Description
static ApprovalFlowCompletedMessagePayloadBuilder	builder()	builder factory method for ApprovalFlowCompletedMessagePayload
static ApprovalFlowCompletedMessagePayloadBuilder	builder(ApprovalFlowCompletedMessagePayload template)	create builder for ApprovalFlowCompletedMessagePayload instance
ApprovalFlowCompletedMessagePayload	copyDeep()
static ApprovalFlowCompletedMessagePayload	deepCopy(ApprovalFlowCompletedMessagePayload template)	factory method to create a deep copy of ApprovalFlowCompletedMessagePayload
@NotNull @Valid OrderReference	getOrder()	Reference to the Order related to the completed Approval Flow.
@NotNull ApprovalFlowStatus	getStatus()	Final status of the Approval Flow.
static ApprovalFlowCompletedMessagePayload	of()	factory method
static ApprovalFlowCompletedMessagePayload	of(ApprovalFlowCompletedMessagePayload template)	factory method to create a shallow copy ApprovalFlowCompletedMessagePayload
void	setOrder(OrderReference order)	Reference to the Order related to the completed Approval Flow.
void	setStatus(ApprovalFlowStatus status)	Final status of the Approval Flow.
static com.fasterxml.jackson.core.type.TypeReference<ApprovalFlowCompletedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withApprovalFlowCompletedMessagePayload(Function<ApprovalFlowCompletedMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Field Details

APPROVAL_FLOW_COMPLETED

static final String APPROVAL_FLOW_COMPLETED

discriminator value for ApprovalFlowCompletedMessagePayload

See Also:

• Constant Field Values

Method Details

getStatus

@NotNull
@NotNull ApprovalFlowStatus getStatus()

Final status of the Approval Flow.

Returns:

status

getOrder

@NotNull
@Valid
@NotNull @Valid OrderReference getOrder()

Reference to the Order related to the completed Approval Flow.

Returns:

order

setStatus

void setStatus(ApprovalFlowStatus status)

Final status of the Approval Flow.

Parameters:

status - value to be set

setOrder

void setOrder(OrderReference order)

Reference to the Order related to the completed Approval Flow.

Parameters:

order - value to be set

of

static ApprovalFlowCompletedMessagePayload of()

factory method

Returns:

instance of ApprovalFlowCompletedMessagePayload

of

static ApprovalFlowCompletedMessagePayload of(ApprovalFlowCompletedMessagePayload template)

factory method to create a shallow copy ApprovalFlowCompletedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ApprovalFlowCompletedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static ApprovalFlowCompletedMessagePayload deepCopy(@Nullable
 ApprovalFlowCompletedMessagePayload template)

factory method to create a deep copy of ApprovalFlowCompletedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ApprovalFlowCompletedMessagePayloadBuilder builder()

builder factory method for ApprovalFlowCompletedMessagePayload

Returns:

builder

builder

static ApprovalFlowCompletedMessagePayloadBuilder builder(ApprovalFlowCompletedMessagePayload template)

create builder for ApprovalFlowCompletedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withApprovalFlowCompletedMessagePayload

default <T> T withApprovalFlowCompletedMessagePayload(Function<ApprovalFlowCompletedMessagePayload,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<ApprovalFlowCompletedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference