Package com.commercetools.api.models.associate_role

Interface AssociateRoleKeyReference

All Superinterfaces:

KeyReference, WithKey

All Known Implementing Classes:

AssociateRoleKeyReferenceImpl

public interface AssociateRoleKeyReference
extends KeyReference

Reference to an AssociateRole by its key.

Example to create an instance using the builder pattern

     AssociateRoleKeyReference associateRoleKeyReference = AssociateRoleKeyReference.builder()
             .key("{key}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ASSOCIATE_ROLE	discriminator value for AssociateRoleKeyReference

Method Summary

Modifier and Type	Method	Description
static AssociateRoleKeyReferenceBuilder	builder()	builder factory method for AssociateRoleKeyReference
static AssociateRoleKeyReferenceBuilder	builder(AssociateRoleKeyReference template)	create builder for AssociateRoleKeyReference instance
static AssociateRoleKeyReference	deepCopy(AssociateRoleKeyReference template)	factory method to create a deep copy of AssociateRoleKeyReference
@NotNull String	getKey()	Unique and immutable key of the referenced AssociateRole.
static AssociateRoleKeyReference	of()	factory method
static AssociateRoleKeyReference	of(AssociateRoleKeyReference template)	factory method to create a shallow copy AssociateRoleKeyReference
void	setKey(String key)	Unique and immutable key of the referenced AssociateRole.
static com.fasterxml.jackson.core.type.TypeReference<AssociateRoleKeyReference>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAssociateRoleKeyReference(Function<AssociateRoleKeyReference,T> helper)	accessor map function

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

getTypeId, withKeyReference

Field Details

ASSOCIATE_ROLE

static final String ASSOCIATE_ROLE

discriminator value for AssociateRoleKeyReference

See Also:

• Constant Field Values

Method Details

getKey

@NotNull
@NotNull String getKey()

Unique and immutable key of the referenced AssociateRole.

Specified by:

getKey in interface KeyReference

Specified by:

getKey in interface WithKey

Returns:

key

setKey

void setKey(String key)

Unique and immutable key of the referenced AssociateRole.

Specified by:

setKey in interface KeyReference

Parameters:

key - value to be set

of

static AssociateRoleKeyReference of()

factory method

Returns:

instance of AssociateRoleKeyReference

of

static AssociateRoleKeyReference of(AssociateRoleKeyReference template)

factory method to create a shallow copy AssociateRoleKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AssociateRoleKeyReference deepCopy(@Nullable
 AssociateRoleKeyReference template)

factory method to create a deep copy of AssociateRoleKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AssociateRoleKeyReferenceBuilder builder()

builder factory method for AssociateRoleKeyReference

Returns:

builder

builder

static AssociateRoleKeyReferenceBuilder builder(AssociateRoleKeyReference template)

create builder for AssociateRoleKeyReference instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAssociateRoleKeyReference

default <T> T withAssociateRoleKeyReference(Function<AssociateRoleKeyReference,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<AssociateRoleKeyReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference