Package com.commercetools.api.models.category

Interface CategoryResourceIdentifier

All Superinterfaces:

Identifiable<Category>, ResourceIdentifier, WithKey

public interface CategoryResourceIdentifier
extends ResourceIdentifier, Identifiable<Category>

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

Example to create an instance using the builder pattern

     CategoryResourceIdentifier categoryResourceIdentifier = CategoryResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CATEGORY	discriminator value for CategoryResourceIdentifier

Method Summary

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

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

getTypeId, withResourceIdentifier

Field Details

CATEGORY

static final String CATEGORY

discriminator value for CategoryResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

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

Specified by:

getId in interface Identifiable<Category>

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

User-defined unique identifier of the referenced Category. Required if id is absent.

Specified by:

getKey in interface ResourceIdentifier

Specified by:

getKey in interface WithKey

Returns:

key

setId

void setId(String id)

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

Specified by:

setId in interface ResourceIdentifier

Parameters:

id - value to be set

setKey

void setKey(String key)

User-defined unique identifier of the referenced Category. Required if id is absent.

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static CategoryResourceIdentifier of()

factory method

Returns:

instance of CategoryResourceIdentifier

of

static CategoryResourceIdentifier of(CategoryResourceIdentifier template)

factory method to create a shallow copy CategoryResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CategoryResourceIdentifier deepCopy(@Nullable
 CategoryResourceIdentifier template)

factory method to create a deep copy of CategoryResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CategoryResourceIdentifierBuilder builder()

builder factory method for CategoryResourceIdentifier

Returns:

builder

builder

static CategoryResourceIdentifierBuilder builder(CategoryResourceIdentifier template)

create builder for CategoryResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCategoryResourceIdentifier

default <T> T withCategoryResourceIdentifier(Function<CategoryResourceIdentifier,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<CategoryResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference