com.commercetools.api.models.category

Interface Category

All Superinterfaces:

BaseResource, DomainResource<Category>

All Known Implementing Classes:

CategoryImpl

public interface Category
extends BaseResource, DomainResource<Category>

Method Summary

Modifier and Type	Method and Description
static CategoryBuilder	builder()
static CategoryBuilder	builder(Category template)
@NotNull @Valid List<CategoryReference>	getAncestors() Contains the parent path towards the root category.
@Valid List<Asset>	getAssets() Can be used to store images, icons or movies related to this category.
@NotNull ZonedDateTime	getCreatedAt()
@Valid CreatedBy	getCreatedBy() Present on resources created after 1/02/2019 except for events not tracked.
@Valid CustomFields	getCustom()
@Valid LocalizedString	getDescription()
String	getExternalId()
@NotNull String	getId() The unique ID of the category.
String	getKey() User-specific unique identifier for the category.
@NotNull ZonedDateTime	getLastModifiedAt()
@Valid LastModifiedBy	getLastModifiedBy() Present on resources updated after 1/02/2019 except for events not tracked.
@Valid LocalizedString	getMetaDescription()
@Valid LocalizedString	getMetaKeywords()
@Valid LocalizedString	getMetaTitle()
@NotNull @Valid LocalizedString	getName()
@NotNull String	getOrderHint() An attribute as base for a custom category order in one level.
@Valid CategoryReference	getParent() A category that is the parent of this category in the category tree.
@NotNull @Valid LocalizedString	getSlug() human-readable identifiers usually used as deep-link URL to the related category.
@NotNull Long	getVersion() The current version of the category.
static Category	of()
static Category	of(Category template)
void	setAncestors(CategoryReference... ancestors)
void	setAncestors(List<CategoryReference> ancestors)
void	setAssets(Asset... assets)
void	setAssets(List<Asset> assets)
void	setCreatedAt(ZonedDateTime createdAt)
void	setCreatedBy(CreatedBy createdBy)
void	setCustom(CustomFields custom)
void	setDescription(LocalizedString description)
void	setExternalId(String externalId)
void	setId(String id)
void	setKey(String key)
void	setLastModifiedAt(ZonedDateTime lastModifiedAt)
void	setLastModifiedBy(LastModifiedBy lastModifiedBy)
void	setMetaDescription(LocalizedString metaDescription)
void	setMetaKeywords(LocalizedString metaKeywords)
void	setMetaTitle(LocalizedString metaTitle)
void	setName(LocalizedString name)
void	setOrderHint(String orderHint)
void	setParent(CategoryReference parent)
void	setSlug(LocalizedString slug)
void	setVersion(Long version)
default <T> T	withCategory(Function<Category,T> helper)

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

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

Method Detail

getId

@NotNull
@NotNull String getId()

The unique ID of the category.

Specified by:

getId in interface BaseResource

Specified by:

getId in interface DomainResource<Category>

getVersion

@NotNull
@NotNull Long getVersion()

The current version of the category.

Specified by:

getVersion in interface BaseResource

Specified by:

getVersion in interface DomainResource<Category>

getCreatedAt

@NotNull
@NotNull ZonedDateTime getCreatedAt()

Specified by:

getCreatedAt in interface BaseResource

getLastModifiedAt

@NotNull
@NotNull ZonedDateTime getLastModifiedAt()

Specified by:

getLastModifiedAt in interface BaseResource

getLastModifiedBy

@Valid
@Valid LastModifiedBy getLastModifiedBy()

Present on resources updated after 1/02/2019 except for events not tracked.

getCreatedBy

@Valid
@Valid CreatedBy getCreatedBy()

Present on resources created after 1/02/2019 except for events not tracked.

getName

@NotNull
 @Valid
@NotNull @Valid LocalizedString getName()

getSlug

@NotNull
 @Valid
@NotNull @Valid LocalizedString getSlug()

human-readable identifiers usually used as deep-link URL to the related category. Each slug is unique across a project, but a category can have the same slug for different languages.

getDescription

@Valid
@Valid LocalizedString getDescription()

getAncestors

@NotNull
 @Valid
@NotNull @Valid List<CategoryReference> getAncestors()

Contains the parent path towards the root category.

getParent

@Valid
@Valid CategoryReference getParent()

A category that is the parent of this category in the category tree.

getOrderHint

@NotNull
@NotNull String getOrderHint()

An attribute as base for a custom category order in one level.

getExternalId

String getExternalId()

getMetaTitle

@Valid
@Valid LocalizedString getMetaTitle()

getMetaDescription

@Valid
@Valid LocalizedString getMetaDescription()

getMetaKeywords

@Valid
@Valid LocalizedString getMetaKeywords()

getCustom

@Valid
@Valid CustomFields getCustom()

getAssets

@Valid
@Valid List<Asset> getAssets()

Can be used to store images, icons or movies related to this category.

getKey

String getKey()

User-specific unique identifier for the category.

setId

void setId(String id)

Specified by:

setId in interface BaseResource

setVersion

void setVersion(Long version)

Specified by:

setVersion in interface BaseResource

setCreatedAt

void setCreatedAt(ZonedDateTime createdAt)

Specified by:

setCreatedAt in interface BaseResource

setLastModifiedAt

void setLastModifiedAt(ZonedDateTime lastModifiedAt)

Specified by:

setLastModifiedAt in interface BaseResource

setLastModifiedBy

void setLastModifiedBy(LastModifiedBy lastModifiedBy)

setCreatedBy

void setCreatedBy(CreatedBy createdBy)

setName

void setName(LocalizedString name)

setSlug

void setSlug(LocalizedString slug)

setDescription

void setDescription(LocalizedString description)

setAncestors

void setAncestors(CategoryReference... ancestors)

setAncestors

void setAncestors(List<CategoryReference> ancestors)

setParent

void setParent(CategoryReference parent)

setOrderHint

void setOrderHint(String orderHint)

setExternalId

void setExternalId(String externalId)

setMetaTitle

void setMetaTitle(LocalizedString metaTitle)

setMetaDescription

void setMetaDescription(LocalizedString metaDescription)

setMetaKeywords

void setMetaKeywords(LocalizedString metaKeywords)

setCustom

void setCustom(CustomFields custom)

setAssets

void setAssets(Asset... assets)

setAssets

void setAssets(List<Asset> assets)

setKey

void setKey(String key)

of

static Category of()

of

static Category of(Category template)

builder

static CategoryBuilder builder()

builder

static CategoryBuilder builder(Category template)

withCategory

default <T> T withCategory(Function<Category,T> helper)