Package com.commercetools.api.models.message

Interface ApprovalFlowApprovedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

All Known Implementing Classes:

ApprovalFlowApprovedMessagePayloadImpl

public interface ApprovalFlowApprovedMessagePayload
extends MessagePayload

Generated after an approval in the Approval Flow.

Example to create an instance using the builder pattern

     ApprovalFlowApprovedMessagePayload approvalFlowApprovedMessagePayload = ApprovalFlowApprovedMessagePayload.builder()
             .associate(associateBuilder -> associateBuilder)
             .order(orderBuilder -> orderBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPROVAL_FLOW_APPROVED	discriminator value for ApprovalFlowApprovedMessagePayload

Method Summary

Modifier and Type	Method	Description
static ApprovalFlowApprovedMessagePayloadBuilder	builder()	builder factory method for ApprovalFlowApprovedMessagePayload
static ApprovalFlowApprovedMessagePayloadBuilder	builder(ApprovalFlowApprovedMessagePayload template)	create builder for ApprovalFlowApprovedMessagePayload instance
static ApprovalFlowApprovedMessagePayload	deepCopy(ApprovalFlowApprovedMessagePayload template)	factory method to create a deep copy of ApprovalFlowApprovedMessagePayload
@NotNull @Valid CustomerReference	getAssociate()	Reference to the Customer who approved the Approval Flow.
@NotNull @Valid OrderReference	getOrder()	Reference to the Order that received the approval.
static ApprovalFlowApprovedMessagePayload	of()	factory method
static ApprovalFlowApprovedMessagePayload	of(ApprovalFlowApprovedMessagePayload template)	factory method to create a shallow copy ApprovalFlowApprovedMessagePayload
void	setAssociate(CustomerReference associate)	Reference to the Customer who approved the Approval Flow.
void	setOrder(OrderReference order)	Reference to the Order that received the approval.
static com.fasterxml.jackson.core.type.TypeReference<ApprovalFlowApprovedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withApprovalFlowApprovedMessagePayload(Function<ApprovalFlowApprovedMessagePayload,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_APPROVED

static final String APPROVAL_FLOW_APPROVED

discriminator value for ApprovalFlowApprovedMessagePayload

See Also:

• Constant Field Values

Method Details

getAssociate

@NotNull
@Valid
@NotNull @Valid CustomerReference getAssociate()

Reference to the Customer who approved the Approval Flow.

Returns:

associate

getOrder

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

Reference to the Order that received the approval.

Returns:

order

setAssociate

void setAssociate(CustomerReference associate)

Reference to the Customer who approved the Approval Flow.

Parameters:

associate - value to be set

setOrder

void setOrder(OrderReference order)

Reference to the Order that received the approval.

Parameters:

order - value to be set

of

static ApprovalFlowApprovedMessagePayload of()

factory method

Returns:

instance of ApprovalFlowApprovedMessagePayload

of

static ApprovalFlowApprovedMessagePayload of(ApprovalFlowApprovedMessagePayload template)

factory method to create a shallow copy ApprovalFlowApprovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ApprovalFlowApprovedMessagePayload deepCopy(@Nullable
 ApprovalFlowApprovedMessagePayload template)

factory method to create a deep copy of ApprovalFlowApprovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ApprovalFlowApprovedMessagePayloadBuilder builder()

builder factory method for ApprovalFlowApprovedMessagePayload

Returns:

builder

builder

static ApprovalFlowApprovedMessagePayloadBuilder builder(ApprovalFlowApprovedMessagePayload template)

create builder for ApprovalFlowApprovedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withApprovalFlowApprovedMessagePayload

default <T> T withApprovalFlowApprovedMessagePayload(Function<ApprovalFlowApprovedMessagePayload,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<ApprovalFlowApprovedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference