Package com.commercetools.api.models.type

Interface CustomFieldReferenceType

All Superinterfaces:

FieldType

public interface CustomFieldReferenceType
extends FieldType

Field type for Reference values.

Example to create an instance using the builder pattern

     CustomFieldReferenceType customFieldReferenceType = CustomFieldReferenceType.builder()
             .referenceTypeId(CustomFieldReferenceValue.APPROVAL_FLOW)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REFERENCE	discriminator value for CustomFieldReferenceType

Method Summary

Modifier and Type	Method	Description
static CustomFieldReferenceTypeBuilder	builder()	builder factory method for CustomFieldReferenceType
static CustomFieldReferenceTypeBuilder	builder(CustomFieldReferenceType template)	create builder for CustomFieldReferenceType instance
static CustomFieldReferenceType	deepCopy(CustomFieldReferenceType template)	factory method to create a deep copy of CustomFieldReferenceType
@NotNull CustomFieldReferenceValue	getReferenceTypeId()	Resource type the Custom Field can reference.
static CustomFieldReferenceType	of()	factory method
static CustomFieldReferenceType	of(CustomFieldReferenceType template)	factory method to create a shallow copy CustomFieldReferenceType
void	setReferenceTypeId(CustomFieldReferenceValue referenceTypeId)	Resource type the Custom Field can reference.
static com.fasterxml.jackson.core.type.TypeReference<CustomFieldReferenceType>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomFieldReferenceType(Function<CustomFieldReferenceType,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.type.FieldType

getName, withFieldType

Field Details

REFERENCE

static final String REFERENCE

discriminator value for CustomFieldReferenceType

See Also:

• Constant Field Values

Method Details

getReferenceTypeId

@NotNull
@NotNull CustomFieldReferenceValue getReferenceTypeId()

Resource type the Custom Field can reference.

Returns:

referenceTypeId

setReferenceTypeId

void setReferenceTypeId(CustomFieldReferenceValue referenceTypeId)

Resource type the Custom Field can reference.

Parameters:

referenceTypeId - value to be set

of

static CustomFieldReferenceType of()

factory method

Returns:

instance of CustomFieldReferenceType

of

static CustomFieldReferenceType of(CustomFieldReferenceType template)

factory method to create a shallow copy CustomFieldReferenceType

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomFieldReferenceType deepCopy(@Nullable
 CustomFieldReferenceType template)

factory method to create a deep copy of CustomFieldReferenceType

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomFieldReferenceTypeBuilder builder()

builder factory method for CustomFieldReferenceType

Returns:

builder

builder

static CustomFieldReferenceTypeBuilder builder(CustomFieldReferenceType template)

create builder for CustomFieldReferenceType instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomFieldReferenceType

default <T> T withCustomFieldReferenceType(Function<CustomFieldReferenceType,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<CustomFieldReferenceType> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference