io.sphere.sdk.zones

Interface Zone

All Superinterfaces:

CreationTimestamped, Identifiable<Zone>, Referenceable<Zone>, Resource<Zone>, ResourceIdentifiable<Zone>, ResourceView<Zone,Zone>, Timestamped, Versioned<Zone>

public interface Zone
extends Resource<Zone>

Zones define Shipping Rates for a set of Locations.

See Also:

ZoneCreateCommand, ZoneUpdateCommand, ZoneDeleteCommand, ZoneQuery, ZoneByIdGet, ShippingMethod.getZones(), ZoneRate.getZone()

Method Summary

Modifier and Type	Method and Description
default boolean	contains(com.neovisionaries.i18n.CountryCode countryCode) Looks up the locations and checks if the country is present.
String	getDescription()
String	getKey()
Set<Location>	getLocations()
String	getName()
static Reference<Zone>	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.
default Reference<Zone>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<Zone>	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()

getKey

@Nullable
String getKey()

Returns:

Unique identifier for a zone. Must be unique across a project.

getDescription

@Nullable
String getDescription()

getLocations

Set<Location> getLocations()

toReference

default Reference<Zone> toReference()

Description copied from interface: Referenceable

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

Specified by:

toReference in interface Referenceable<Zone>

Specified by:

toReference in interface Resource<Zone>

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

typeReference

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

contains

default boolean contains(com.neovisionaries.i18n.CountryCode countryCode)

Looks up the locations and checks if the country is present. It does not matter if the location has a state specified.

Parameters:

countryCode - the country to search for

Returns:

true if the country is somehow in the locations.

referenceOfId

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