Package com.commercetools.api.models.recurrence_policy

Interface RecurrencePolicyResourceIdentifier

All Superinterfaces:

ResourceIdentifier, WithKey

public interface RecurrencePolicyResourceIdentifier
extends ResourceIdentifier

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

Example to create an instance using the builder pattern

     RecurrencePolicyResourceIdentifier recurrencePolicyResourceIdentifier = RecurrencePolicyResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RECURRENCE_POLICY	discriminator value for RecurrencePolicyResourceIdentifier

Method Summary

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

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

getTypeId, withResourceIdentifier

Field Details

RECURRENCE_POLICY

static final String RECURRENCE_POLICY

discriminator value for RecurrencePolicyResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

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

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

User-defined unique identifier of the referenced RecurrencePolicy. 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 RecurrencePolicy. 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 RecurrencePolicy. Required if id is absent.

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static RecurrencePolicyResourceIdentifier of()

factory method

Returns:

instance of RecurrencePolicyResourceIdentifier

of

static RecurrencePolicyResourceIdentifier of(RecurrencePolicyResourceIdentifier template)

factory method to create a shallow copy RecurrencePolicyResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurrencePolicyResourceIdentifier copyDeep()

Specified by:

copyDeep in interface ResourceIdentifier

deepCopy

@Nullable
static RecurrencePolicyResourceIdentifier deepCopy(@Nullable
 RecurrencePolicyResourceIdentifier template)

factory method to create a deep copy of RecurrencePolicyResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurrencePolicyResourceIdentifierBuilder builder()

builder factory method for RecurrencePolicyResourceIdentifier

Returns:

builder

builder

static RecurrencePolicyResourceIdentifierBuilder builder(RecurrencePolicyResourceIdentifier template)

create builder for RecurrencePolicyResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurrencePolicyResourceIdentifier

default <T> T withRecurrencePolicyResourceIdentifier(Function<RecurrencePolicyResourceIdentifier,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<RecurrencePolicyResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference