Package com.commercetools.api.models.business_unit

Interface BusinessUnitKeyReference

All Superinterfaces:

KeyReference, WithKey

public interface BusinessUnitKeyReference
extends KeyReference

KeyReference to a BusinessUnit.

Example to create an instance using the builder pattern

     BusinessUnitKeyReference businessUnitKeyReference = BusinessUnitKeyReference.builder()
             .key("{key}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUSINESS_UNIT	discriminator value for BusinessUnitKeyReference

Method Summary

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

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

getTypeId, withKeyReference

Field Details

BUSINESS_UNIT

static final String BUSINESS_UNIT

discriminator value for BusinessUnitKeyReference

See Also:

• Constant Field Values

Method Details

getKey

@NotNull
@NotNull String getKey()

Unique and immutable key of the referenced BusinessUnit.

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 BusinessUnit.

Specified by:

setKey in interface KeyReference

Parameters:

key - value to be set

of

static BusinessUnitKeyReference of()

factory method

Returns:

instance of BusinessUnitKeyReference

of

static BusinessUnitKeyReference of(BusinessUnitKeyReference template)

factory method to create a shallow copy BusinessUnitKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

BusinessUnitKeyReference copyDeep()

Specified by:

copyDeep in interface KeyReference

deepCopy

@Nullable
static BusinessUnitKeyReference deepCopy(@Nullable
 BusinessUnitKeyReference template)

factory method to create a deep copy of BusinessUnitKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitKeyReferenceBuilder builder()

builder factory method for BusinessUnitKeyReference

Returns:

builder

builder

static BusinessUnitKeyReferenceBuilder builder(BusinessUnitKeyReference template)

create builder for BusinessUnitKeyReference instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitKeyReference

default <T> T withBusinessUnitKeyReference(Function<BusinessUnitKeyReference,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<BusinessUnitKeyReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference