Package com.commercetools.history.models.common

Interface BusinessUnitResourceIdentifier

All Superinterfaces:

ResourceIdentifier

public interface BusinessUnitResourceIdentifier
extends ResourceIdentifier

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

Example to create an instance using the builder pattern

     BusinessUnitResourceIdentifier businessUnitResourceIdentifier = BusinessUnitResourceIdentifier.builder()
             .typeId(ReferenceTypeId.APPROVAL_FLOW)
             .build()
 

Field Summary

Fields

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

Method Summary

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

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

getTypeId, setTypeId, withResourceIdentifier

Field Details

BUSINESS_UNIT

static final String BUSINESS_UNIT

discriminator value for BusinessUnitResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

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

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

Unique key of the referenced BusinessUnit. Required if id is absent.

Specified by:

getKey in interface ResourceIdentifier

Returns:

key

setId

void setId(String id)

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

Specified by:

setId in interface ResourceIdentifier

Parameters:

id - value to be set

setKey

void setKey(String key)

Unique key of the referenced BusinessUnit. Required if id is absent.

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static BusinessUnitResourceIdentifier of()

factory method

Returns:

instance of BusinessUnitResourceIdentifier

of

static BusinessUnitResourceIdentifier of(BusinessUnitResourceIdentifier template)

factory method to create a shallow copy BusinessUnitResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

BusinessUnitResourceIdentifier copyDeep()

Specified by:

copyDeep in interface ResourceIdentifier

deepCopy

@Nullable
static BusinessUnitResourceIdentifier deepCopy(@Nullable
 BusinessUnitResourceIdentifier template)

factory method to create a deep copy of BusinessUnitResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitResourceIdentifierBuilder builder()

builder factory method for BusinessUnitResourceIdentifier

Returns:

builder

builder

static BusinessUnitResourceIdentifierBuilder builder(BusinessUnitResourceIdentifier template)

create builder for BusinessUnitResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitResourceIdentifier

default <T> T withBusinessUnitResourceIdentifier(Function<BusinessUnitResourceIdentifier,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<BusinessUnitResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference