io.sphere.sdk.taxcategories

Interface TaxCategory

All Superinterfaces:

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

public interface TaxCategory
extends Resource<TaxCategory>, WithKey

Tax Categories define how products are to be taxed in different countries.

See Also:

TaxCategoryCreateCommand, TaxCategoryUpdateCommand, TaxCategoryDeleteCommand, TaxCategoryByIdGet, TaxCategoryQuery, CartShippingInfo.getTaxCategory(), OrderShippingInfo.getTaxCategory(), CustomLineItem.getTaxCategory(), ProductLike.getTaxCategory(), ProductLike.getTaxCategory(), ShippingMethod.getTaxCategory()

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getKey()
String	getName()
List<TaxRate>	getRates()
default List<TaxRate>	getTaxRates() Gets the tax rates.
static Reference<TaxCategory>	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<TaxCategory>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<TaxCategory>	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

@Nullable
String getDescription()

getKey

@Nullable
String getKey()

Specified by:

getKey in interface WithKey

getTaxRates

default List<TaxRate> getTaxRates()

Gets the tax rates. Alias for getRates().

Returns:

rates

getRates

List<TaxRate> getRates()

typeReference

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

toReference

default Reference<TaxCategory> toReference()

Description copied from interface: Referenceable

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

Specified by:

toReference in interface Referenceable<TaxCategory>

Specified by:

toReference in interface Resource<TaxCategory>

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()

referenceOfId

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