Package com.commercetools.api.models.recurrence_policy

Interface RecurrencePolicyReference

All Superinterfaces:

Reference, ReferenceMixin

public interface RecurrencePolicyReference
extends Reference

Reference to a RecurrencePolicy.

Example to create an instance using the builder pattern

     RecurrencePolicyReference recurrencePolicyReference = RecurrencePolicyReference.builder()
             .id("{id}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static RecurrencePolicyReferenceBuilder	builder()	builder factory method for RecurrencePolicyReference
static RecurrencePolicyReferenceBuilder	builder(RecurrencePolicyReference template)	create builder for RecurrencePolicyReference instance
RecurrencePolicyReference	copyDeep()
static RecurrencePolicyReference	deepCopy(RecurrencePolicyReference template)	factory method to create a deep copy of RecurrencePolicyReference
@NotNull String	getId()	Unique identifier of the referenced RecurrencePolicy.
@Valid RecurrencePolicy	getObj()	Contains the representation of the expanded RecurrencePolicy.
@NotNull ReferenceTypeId	getTypeId()	Type of referenced resource.
static RecurrencePolicyReference	of()	factory method
static RecurrencePolicyReference	of(RecurrencePolicyReference template)	factory method to create a shallow copy RecurrencePolicyReference
void	setId(String id)	Unique identifier of the referenced RecurrencePolicy.
void	setObj(RecurrencePolicy obj)	Contains the representation of the expanded RecurrencePolicy.
static tools.jackson.core.type.TypeReference<RecurrencePolicyReference>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withRecurrencePolicyReference(Function<RecurrencePolicyReference,T> helper)	accessor map function

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

withReference

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

toResourceIdentifier

Field Details

RECURRENCE_POLICY

static final String RECURRENCE_POLICY

discriminator value for RecurrencePolicyReference

See Also:

• Constant Field Values

Method Details

getTypeId

@NotNull
@NotNull ReferenceTypeId getTypeId()

Description copied from interface: Reference

Type of referenced resource.

Specified by:

getTypeId in interface Reference

Specified by:

getTypeId in interface ReferenceMixin

Returns:

typeId

getObj

@Valid
@Valid RecurrencePolicy getObj()

Contains the representation of the expanded RecurrencePolicy. Only present in responses to requests with Reference Expansion for RecurrencePolicies.

Returns:

obj

getId

@NotNull
@NotNull String getId()

Unique identifier of the referenced RecurrencePolicy.

Specified by:

getId in interface Reference

Specified by:

getId in interface ReferenceMixin

Returns:

id

setObj

void setObj(RecurrencePolicy obj)

Contains the representation of the expanded RecurrencePolicy. Only present in responses to requests with Reference Expansion for RecurrencePolicies.

Parameters:

obj - value to be set

setId

void setId(String id)

Unique identifier of the referenced RecurrencePolicy.

Specified by:

setId in interface Reference

Parameters:

id - value to be set

of

static RecurrencePolicyReference of()

factory method

Returns:

instance of RecurrencePolicyReference

of

static RecurrencePolicyReference of(RecurrencePolicyReference template)

factory method to create a shallow copy RecurrencePolicyReference

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurrencePolicyReference copyDeep()

Specified by:

copyDeep in interface Reference

deepCopy

@Nullable
static RecurrencePolicyReference deepCopy(@Nullable
 RecurrencePolicyReference template)

factory method to create a deep copy of RecurrencePolicyReference

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurrencePolicyReferenceBuilder builder()

builder factory method for RecurrencePolicyReference

Returns:

builder

builder

static RecurrencePolicyReferenceBuilder builder(RecurrencePolicyReference template)

create builder for RecurrencePolicyReference instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurrencePolicyReference

default <T> T withRecurrencePolicyReference(Function<RecurrencePolicyReference,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<RecurrencePolicyReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference