io.sphere.sdk.categories

Interface Category

All Superinterfaces:

CreationTimestamped, Custom, Identifiable<Category>, MetaAttributes, Referenceable<Category>, Resource<Category>, ResourceIdentifiable<Category>, ResourceView<Category,Category>, Timestamped, Versioned<Category>, WithKey, WithLocalizedSlug

public interface Category
extends Resource<Category>, WithLocalizedSlug, MetaAttributes, Custom, WithKey

Categories are used to organize products in a hierarchical structure.

A category can have custom fields.

Consult the documentation for categories for more information.

See Also:

CategoryCreateCommand, CategoryUpdateCommand, CategoryDeleteCommand, CategoryQuery, CategoryByIdGet, CategoryTree, ProductData.getCategories(), ProductData.getCategoryOrderHints(), ProductProjection.getCategories(), ProductProjection.getCategoryOrderHints(), AddToCategory, RemoveFromCategory

Method Summary

Modifier and Type	Method and Description
List<Reference<Category>>	getAncestors()
List<Asset>	getAssets()
CustomFields	getCustom() Custom fields.
LocalizedString	getDescription() Description for this category.
String	getExternalId() ID which can be used as additional identifier for external Systems like CRM or ERP.
String	getKey() User-specific unique identifier for the Category.
LocalizedString	getMetaDescription() SEO meta description.
LocalizedString	getMetaKeywords() SEO meta keywords.
LocalizedString	getMetaTitle() SEO meta title.
LocalizedString	getName() Name of this category.
String	getOrderHint() An attribute as base for a custom category order in one level.
Reference<Category>	getParent() Reference to the parent category.
LocalizedString	getSlug() Human-readable identifier usually used as deep-link URL part.
static Reference<Category>	reference(String id)
static Reference<Category>	referenceOfId(String id) Creates a reference for one item of this class by a known ID.
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
static String	resourceTypeId() An identifier for this resource which supports CustomFields.
default Reference<Category>	toReference() Creates a reference to this resource, the reference may not be filled.
static String	toString(Category category)
static com.fasterxml.jackson.core.type.TypeReference<Category>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Methods inherited from interface io.sphere.sdk.models.MetaAttributes

metaAttributesOf, metaAttributesOf

Method Detail

getKey

@Nullable
String getKey()

User-specific unique identifier for the Category.

Specified by:

getKey in interface WithKey

Returns:

the user defined key

getName

LocalizedString getName()

Name of this category.

Returns:

name

See Also:

ChangeName

getSlug

LocalizedString getSlug()

Human-readable identifier usually used as deep-link URL part.

Specified by:

getSlug in interface WithLocalizedSlug

Returns:

slug

See Also:

ChangeSlug

getDescription

@Nullable
LocalizedString getDescription()

Description for this category.

Returns:

description or null

See Also:

SetDescription

getAncestors

List<Reference<Category>> getAncestors()

getParent

@Nullable
Reference<Category> getParent()

Reference to the parent category.

Returns:

parent reference or null

See Also:

ChangeParent

getOrderHint

@Nullable
String getOrderHint()

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

Returns:

order hint or null

See Also:

ChangeOrderHint

getExternalId

@Nullable
String getExternalId()

ID which can be used as additional identifier for external Systems like CRM or ERP.

Returns:

external ID or null

See Also:

SetExternalId

getMetaTitle

@Nullable
LocalizedString getMetaTitle()

SEO meta title.

Specified by:

getMetaTitle in interface MetaAttributes

Returns:

SEO meta title.

See Also:

SetMetaTitle

getMetaDescription

@Nullable
LocalizedString getMetaDescription()

SEO meta description.

Specified by:

getMetaDescription in interface MetaAttributes

Returns:

SEO meta description.

See Also:

SetMetaDescription

getMetaKeywords

@Nullable
LocalizedString getMetaKeywords()

SEO meta keywords.

Specified by:

getMetaKeywords in interface MetaAttributes

Returns:

SEO meta keywords.

See Also:

SetMetaKeywords

getCustom

@Nullable
CustomFields getCustom()

Custom fields.

Specified by:

getCustom in interface Custom

Returns:

custom fields

See Also:

Custom, SetCustomField, SetCustomType

getAssets

@Nonnull
List<Asset> getAssets()

toReference

default Reference<Category> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<Category>

Specified by:

toReference in interface Resource<Category>

Returns:

reference

resourceTypeId

static String resourceTypeId()

An identifier for this resource which supports CustomFields.

Returns:

ID of this resource type

See Also:

TypeDraft.getResourceTypeIds(), Custom

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

reference

static Reference<Category> reference(String id)

typeReference

static com.fasterxml.jackson.core.type.TypeReference<Category> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

toString

static String toString(Category category)

referenceOfId

static Reference<Category> referenceOfId(String id)

Creates a reference for one item of this class by a known ID.

An example for categories but this applies for other resources, too:

final String categoryIdFromFormOrSession = "84ac4271-0fec-49d0-9fee-55586c565c58";
final Reference<Category> categoryReference = Category.referenceOfId(categoryIdFromFormOrSession);
assertThat(categoryReference.getId()).isEqualTo(categoryIdFromFormOrSession);
See the test code.

If you already have a resource object, then use toReference() instead:

final Category category = getCategory1();
final Reference<Category> categoryReference = category.toReference();
assertThat(category.getId()).isEqualTo(categoryReference.getId());
See the test code.

Parameters:

id - the ID of the resource which should be referenced.

Returns:

reference