Package com.commercetools.api.models.message

Interface ApprovalFlowApprovedMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>

public interface ApprovalFlowApprovedMessage
extends Message

Generated after an approval in the Approval Flow.

Example to create an instance using the builder pattern

     ApprovalFlowApprovedMessage approvalFlowApprovedMessage = ApprovalFlowApprovedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .associate(associateBuilder -> associateBuilder)
             .order(orderBuilder -> orderBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ApprovalFlowApprovedMessageBuilder	builder()	builder factory method for ApprovalFlowApprovedMessage
static ApprovalFlowApprovedMessageBuilder	builder(ApprovalFlowApprovedMessage template)	create builder for ApprovalFlowApprovedMessage instance
ApprovalFlowApprovedMessage	copyDeep()
static ApprovalFlowApprovedMessage	deepCopy(ApprovalFlowApprovedMessage template)	factory method to create a deep copy of ApprovalFlowApprovedMessage
@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 ApprovalFlowApprovedMessage	of()	factory method
static ApprovalFlowApprovedMessage	of(ApprovalFlowApprovedMessage template)	factory method to create a shallow copy ApprovalFlowApprovedMessage
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<ApprovalFlowApprovedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withApprovalFlowApprovedMessage(Function<ApprovalFlowApprovedMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

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

get

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

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Field Details

APPROVAL_FLOW_APPROVED

static final String APPROVAL_FLOW_APPROVED

discriminator value for ApprovalFlowApprovedMessage

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 ApprovalFlowApprovedMessage of()

factory method

Returns:

instance of ApprovalFlowApprovedMessage

of

static ApprovalFlowApprovedMessage of(ApprovalFlowApprovedMessage template)

factory method to create a shallow copy ApprovalFlowApprovedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ApprovalFlowApprovedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static ApprovalFlowApprovedMessage deepCopy(@Nullable
 ApprovalFlowApprovedMessage template)

factory method to create a deep copy of ApprovalFlowApprovedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ApprovalFlowApprovedMessageBuilder builder()

builder factory method for ApprovalFlowApprovedMessage

Returns:

builder

builder

static ApprovalFlowApprovedMessageBuilder builder(ApprovalFlowApprovedMessage template)

create builder for ApprovalFlowApprovedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withApprovalFlowApprovedMessage

default <T> T withApprovalFlowApprovedMessage(Function<ApprovalFlowApprovedMessage,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<ApprovalFlowApprovedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference