io.sphere.sdk.producttypes

Interface ProductType

All Superinterfaces:

AttributeDefinitionContainer, CreationTimestamped, Identifiable<ProductType>, Referenceable<ProductType>, Resource<ProductType>, ResourceIdentifiable<ProductType>, ResourceView<ProductType,ProductType>, Timestamped, Versioned<ProductType>, WithKey

public interface ProductType
extends Resource<ProductType>, AttributeDefinitionContainer, WithKey

Describes common characteristics, most importantly common custom attributes, of many concrete products.

See Also:

ProductTypeCreateCommand, ProductTypeUpdateCommand, ProductTypeDeleteCommand, ProductTypeQuery, ProductTypeByIdGet, ProductTypeByKeyGet, ProductLike.getProductType()

Method Summary

Modifier and Type	Method and Description
default Optional<AttributeDefinition>	findAttribute(String attributeName)
default AttributeDefinition	getAttribute(String attributeName)
List<AttributeDefinition>	getAttributes()
String	getDescription()
String	getKey()
String	getName()
static Reference<ProductType>	reference(ProductType productType)
static Reference<ProductType>	reference(String id)
static Reference<ProductType>	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()
default Reference<ProductType>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<ProductType>	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

Method Detail

getName

String getName()

getDescription

String getDescription()

getAttributes

List<AttributeDefinition> getAttributes()

Specified by:

getAttributes in interface AttributeDefinitionContainer

getAttribute

@Nullable
default AttributeDefinition getAttribute(String attributeName)

Specified by:

getAttribute in interface AttributeDefinitionContainer

findAttribute

default Optional<AttributeDefinition> findAttribute(String attributeName)

Specified by:

findAttribute in interface AttributeDefinitionContainer

getKey

@Nullable
String getKey()

Specified by:

getKey in interface WithKey

toReference

default Reference<ProductType> toReference()

Description copied from interface: Referenceable

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

Specified by:

toReference in interface Referenceable<ProductType>

Specified by:

toReference in interface Resource<ProductType>

Returns:

reference

referenceTypeId

static String referenceTypeId()

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

Returns:

type hint

See Also:

Reference.getTypeId()

resourceTypeId

static String resourceTypeId()

reference

static Reference<ProductType> reference(ProductType productType)

reference

static Reference<ProductType> reference(String id)

typeReference

static com.fasterxml.jackson.core.type.TypeReference<ProductType> 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)

referenceOfId

static Reference<ProductType> 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