Package com.commercetools.api.models.recurring_order

Interface RecurringOrderResourceIdentifier

All Superinterfaces:

ResourceIdentifier, WithKey

public interface RecurringOrderResourceIdentifier
extends ResourceIdentifier

ResourceIdentifier to a RecurringOrder. Either id or key is required. If both are set, an InvalidJsonInput error is returned.

Example to create an instance using the builder pattern

     RecurringOrderResourceIdentifier recurringOrderResourceIdentifier = RecurringOrderResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RECURRING_ORDER	discriminator value for RecurringOrderResourceIdentifier

Method Summary

Modifier and Type	Method	Description
static RecurringOrderResourceIdentifierBuilder	builder()	builder factory method for RecurringOrderResourceIdentifier
static RecurringOrderResourceIdentifierBuilder	builder(RecurringOrderResourceIdentifier template)	create builder for RecurringOrderResourceIdentifier instance
RecurringOrderResourceIdentifier	copyDeep()
static RecurringOrderResourceIdentifier	deepCopy(RecurringOrderResourceIdentifier template)	factory method to create a deep copy of RecurringOrderResourceIdentifier
String	getId()	Unique identifier of the referenced RecurringOrder.
String	getKey()	User-defined unique identifier of the referenced RecurringOrder.
static RecurringOrderResourceIdentifier	of()	factory method
static RecurringOrderResourceIdentifier	of(RecurringOrderResourceIdentifier template)	factory method to create a shallow copy RecurringOrderResourceIdentifier
void	setId(String id)	Unique identifier of the referenced RecurringOrder.
void	setKey(String key)	User-defined unique identifier of the referenced RecurringOrder.
static com.fasterxml.jackson.core.type.TypeReference<RecurringOrderResourceIdentifier>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withRecurringOrderResourceIdentifier(Function<RecurringOrderResourceIdentifier,T> helper)	accessor map function

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

getTypeId, withResourceIdentifier

Field Details

RECURRING_ORDER

static final String RECURRING_ORDER

discriminator value for RecurringOrderResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

Unique identifier of the referenced RecurringOrder. Required if key is absent.

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

User-defined unique identifier of the referenced RecurringOrder. Required if id is absent.

Specified by:

getKey in interface ResourceIdentifier

Specified by:

getKey in interface WithKey

Returns:

key

setId

void setId(String id)

Unique identifier of the referenced RecurringOrder. Required if key is absent.

Specified by:

setId in interface ResourceIdentifier

Parameters:

id - value to be set

setKey

void setKey(String key)

User-defined unique identifier of the referenced RecurringOrder. Required if id is absent.

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static RecurringOrderResourceIdentifier of()

factory method

Returns:

instance of RecurringOrderResourceIdentifier

of

static RecurringOrderResourceIdentifier of(RecurringOrderResourceIdentifier template)

factory method to create a shallow copy RecurringOrderResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderResourceIdentifier copyDeep()

Specified by:

copyDeep in interface ResourceIdentifier

deepCopy

@Nullable
static RecurringOrderResourceIdentifier deepCopy(@Nullable
 RecurringOrderResourceIdentifier template)

factory method to create a deep copy of RecurringOrderResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderResourceIdentifierBuilder builder()

builder factory method for RecurringOrderResourceIdentifier

Returns:

builder

builder

static RecurringOrderResourceIdentifierBuilder builder(RecurringOrderResourceIdentifier template)

create builder for RecurringOrderResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderResourceIdentifier

default <T> T withRecurringOrderResourceIdentifier(Function<RecurringOrderResourceIdentifier,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<RecurringOrderResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference