Package com.commercetools.api.models.recurring_order

Interface Counter

All Superinterfaces:

SkipConfiguration

public interface Counter
extends SkipConfiguration

Configuration to track skips for a RecurringOrder.

Example to create an instance using the builder pattern

     Counter counter = Counter.builder()
             .totalToSkip(1)
             .skipped(1)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COUNTER	discriminator value for Counter

Method Summary

Modifier and Type	Method	Description
static CounterBuilder	builder()	builder factory method for Counter
static CounterBuilder	builder(Counter template)	create builder for Counter instance
Counter	copyDeep()
static Counter	deepCopy(Counter template)	factory method to create a deep copy of Counter
ZonedDateTime	getLastSkippedAt()	Date and time (UTC) when the last Order creation was skipped.
@NotNull Integer	getSkipped()	Number of Orders that were already skipped.
@NotNull Integer	getTotalToSkip()	Number of Orders that will be skipped.
static Counter	of()	factory method
static Counter	of(Counter template)	factory method to create a shallow copy Counter
void	setLastSkippedAt(ZonedDateTime lastSkippedAt)	Date and time (UTC) when the last Order creation was skipped.
void	setSkipped(Integer skipped)	Number of Orders that were already skipped.
void	setTotalToSkip(Integer totalToSkip)	Number of Orders that will be skipped.
static com.fasterxml.jackson.core.type.TypeReference<Counter>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCounter(Function<Counter,T> helper)	accessor map function

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

getType, withSkipConfiguration

Field Details

COUNTER

static final String COUNTER

discriminator value for Counter

See Also:

• Constant Field Values

Method Details

getTotalToSkip

@NotNull
@NotNull Integer getTotalToSkip()

Number of Orders that will be skipped.

Returns:

totalToSkip

getSkipped

@NotNull
@NotNull Integer getSkipped()

Number of Orders that were already skipped.

Returns:

skipped

getLastSkippedAt

ZonedDateTime getLastSkippedAt()

Date and time (UTC) when the last Order creation was skipped.

Returns:

lastSkippedAt

setTotalToSkip

void setTotalToSkip(Integer totalToSkip)

Number of Orders that will be skipped.

Parameters:

totalToSkip - value to be set

setSkipped

void setSkipped(Integer skipped)

Number of Orders that were already skipped.

Parameters:

skipped - value to be set

setLastSkippedAt

void setLastSkippedAt(ZonedDateTime lastSkippedAt)

Date and time (UTC) when the last Order creation was skipped.

Parameters:

lastSkippedAt - value to be set

of

static Counter of()

factory method

Returns:

instance of Counter

of

static Counter of(Counter template)

factory method to create a shallow copy Counter

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

Counter copyDeep()

Specified by:

copyDeep in interface SkipConfiguration

deepCopy

@Nullable
static Counter deepCopy(@Nullable
 Counter template)

factory method to create a deep copy of Counter

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CounterBuilder builder()

builder factory method for Counter

Returns:

builder

builder

static CounterBuilder builder(Counter template)

create builder for Counter instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCounter

default <T> T withCounter(Function<Counter,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<Counter> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference