Package com.commercetools.api.models.recurring_order

Interface RecurringOrderCanceled

All Superinterfaces:

RecurringOrderStateDraft

public interface RecurringOrderCanceled
extends RecurringOrderStateDraft

Changes the Recurring Order state to canceled.

Example to create an instance using the builder pattern

     RecurringOrderCanceled recurringOrderCanceled = RecurringOrderCanceled.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CANCELED	discriminator value for RecurringOrderCanceled

Method Summary

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

Methods inherited from interface com.commercetools.api.models.recurring_order.RecurringOrderStateDraft

getType, withRecurringOrderStateDraft

Field Details

CANCELED

static final String CANCELED

discriminator value for RecurringOrderCanceled

See Also:

• Constant Field Values

Method Details

getReason

String getReason()

The reason for the cancelation.

Returns:

reason

setReason

void setReason(String reason)

The reason for the cancelation.

Parameters:

reason - value to be set

of

static RecurringOrderCanceled of()

factory method

Returns:

instance of RecurringOrderCanceled

of

static RecurringOrderCanceled of(RecurringOrderCanceled template)

factory method to create a shallow copy RecurringOrderCanceled

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderCanceled copyDeep()

Specified by:

copyDeep in interface RecurringOrderStateDraft

deepCopy

@Nullable
static RecurringOrderCanceled deepCopy(@Nullable
 RecurringOrderCanceled template)

factory method to create a deep copy of RecurringOrderCanceled

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderCanceledBuilder builder()

builder factory method for RecurringOrderCanceled

Returns:

builder

builder

static RecurringOrderCanceledBuilder builder(RecurringOrderCanceled template)

create builder for RecurringOrderCanceled instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderCanceled

default <T> T withRecurringOrderCanceled(Function<RecurringOrderCanceled,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<RecurringOrderCanceled> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference