Package com.commercetools.api.models.message

Interface ApprovalFlowCompletedMessage

All Superinterfaces:

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

public interface ApprovalFlowCompletedMessage
extends Message

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

Example to create an instance using the builder pattern

     ApprovalFlowCompletedMessage approvalFlowCompletedMessage = ApprovalFlowCompletedMessage.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)
             .status(ApprovalFlowStatus.PENDING)
             .order(orderBuilder -> orderBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ApprovalFlowCompletedMessageBuilder	builder()	builder factory method for ApprovalFlowCompletedMessage
static ApprovalFlowCompletedMessageBuilder	builder(ApprovalFlowCompletedMessage template)	create builder for ApprovalFlowCompletedMessage instance
ApprovalFlowCompletedMessage	copyDeep()
static ApprovalFlowCompletedMessage	deepCopy(ApprovalFlowCompletedMessage template)	factory method to create a deep copy of ApprovalFlowCompletedMessage
@NotNull @Valid OrderReference	getOrder()	Reference to the Order related to the completed Approval Flow.
@NotNull ApprovalFlowStatus	getStatus()	Final status of the Approval Flow.
static ApprovalFlowCompletedMessage	of()	factory method
static ApprovalFlowCompletedMessage	of(ApprovalFlowCompletedMessage template)	factory method to create a shallow copy ApprovalFlowCompletedMessage
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<ApprovalFlowCompletedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withApprovalFlowCompletedMessage(Function<ApprovalFlowCompletedMessage,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_COMPLETED

static final String APPROVAL_FLOW_COMPLETED

discriminator value for ApprovalFlowCompletedMessage

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

factory method

Returns:

instance of ApprovalFlowCompletedMessage

of

static ApprovalFlowCompletedMessage of(ApprovalFlowCompletedMessage template)

factory method to create a shallow copy ApprovalFlowCompletedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ApprovalFlowCompletedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static ApprovalFlowCompletedMessage deepCopy(@Nullable
 ApprovalFlowCompletedMessage template)

factory method to create a deep copy of ApprovalFlowCompletedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ApprovalFlowCompletedMessageBuilder builder()

builder factory method for ApprovalFlowCompletedMessage

Returns:

builder

builder

static ApprovalFlowCompletedMessageBuilder builder(ApprovalFlowCompletedMessage template)

create builder for ApprovalFlowCompletedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withApprovalFlowCompletedMessage

default <T> T withApprovalFlowCompletedMessage(Function<ApprovalFlowCompletedMessage,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<ApprovalFlowCompletedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference