Package com.commercetools.api.models.recurring_order

Interface RecurringOrderSetExpiresAtAction

All Superinterfaces:

RecurringOrderUpdateAction

public interface RecurringOrderSetExpiresAtAction
extends RecurringOrderUpdateAction

Setting the expiration date and time generates the RecurringOrderExpiresAtSet Message.

Example to create an instance using the builder pattern

     RecurringOrderSetExpiresAtAction recurringOrderSetExpiresAtAction = RecurringOrderSetExpiresAtAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_EXPIRES_AT	discriminator value for RecurringOrderSetExpiresAtAction

Method Summary

Modifier and Type	Method	Description
static RecurringOrderSetExpiresAtActionBuilder	builder()	builder factory method for RecurringOrderSetExpiresAtAction
static RecurringOrderSetExpiresAtActionBuilder	builder(RecurringOrderSetExpiresAtAction template)	create builder for RecurringOrderSetExpiresAtAction instance
RecurringOrderSetExpiresAtAction	copyDeep()
static RecurringOrderSetExpiresAtAction	deepCopy(RecurringOrderSetExpiresAtAction template)	factory method to create a deep copy of RecurringOrderSetExpiresAtAction
ZonedDateTime	getExpiresAt()	Date and time (UTC) the Recurring Order should expire.
static RecurringOrderSetExpiresAtAction	of()	factory method
static RecurringOrderSetExpiresAtAction	of(RecurringOrderSetExpiresAtAction template)	factory method to create a shallow copy RecurringOrderSetExpiresAtAction
void	setExpiresAt(ZonedDateTime expiresAt)	Date and time (UTC) the Recurring Order should expire.
static com.fasterxml.jackson.core.type.TypeReference<RecurringOrderSetExpiresAtAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withRecurringOrderSetExpiresAtAction(Function<RecurringOrderSetExpiresAtAction,T> helper)	accessor map function

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

getAction, withRecurringOrderUpdateAction

Field Details

SET_EXPIRES_AT

static final String SET_EXPIRES_AT

discriminator value for RecurringOrderSetExpiresAtAction

See Also:

• Constant Field Values

Method Details

getExpiresAt

ZonedDateTime getExpiresAt()

Date and time (UTC) the Recurring Order should expire. If empty, any existing value will be removed.

If the date or time is extended or removed when the RecurringOrderState is Expired, the state will be updated to Active.

Returns:

expiresAt

setExpiresAt

void setExpiresAt(ZonedDateTime expiresAt)

Date and time (UTC) the Recurring Order should expire. If empty, any existing value will be removed.

If the date or time is extended or removed when the RecurringOrderState is Expired, the state will be updated to Active.

Parameters:

expiresAt - value to be set

of

static RecurringOrderSetExpiresAtAction of()

factory method

Returns:

instance of RecurringOrderSetExpiresAtAction

of

static RecurringOrderSetExpiresAtAction of(RecurringOrderSetExpiresAtAction template)

factory method to create a shallow copy RecurringOrderSetExpiresAtAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderSetExpiresAtAction copyDeep()

Specified by:

copyDeep in interface RecurringOrderUpdateAction

deepCopy

@Nullable
static RecurringOrderSetExpiresAtAction deepCopy(@Nullable
 RecurringOrderSetExpiresAtAction template)

factory method to create a deep copy of RecurringOrderSetExpiresAtAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderSetExpiresAtActionBuilder builder()

builder factory method for RecurringOrderSetExpiresAtAction

Returns:

builder

builder

static RecurringOrderSetExpiresAtActionBuilder builder(RecurringOrderSetExpiresAtAction template)

create builder for RecurringOrderSetExpiresAtAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderSetExpiresAtAction

default <T> T withRecurringOrderSetExpiresAtAction(Function<RecurringOrderSetExpiresAtAction,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<RecurringOrderSetExpiresAtAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference