io.sphere.sdk.shippingmethods

Interface ShippingMethod

All Superinterfaces:

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

public interface ShippingMethod
extends Resource<ShippingMethod>, WithKey, Custom

Shipping Methods define where orders can be shipped and what the costs are.

See Also:

ShippingMethodCreateCommand, ShippingMethodUpdateCommand, ShippingMethodDeleteCommand, ShippingMethodQuery, ShippingMethodByIdGet, CartShippingInfo.getShippingMethod(), OrderShippingInfo.getShippingMethod()

Method Summary

Modifier and Type	Method and Description
CustomFields	getCustom()
String	getDescription() Deprecated.
String	getKey()
LocalizedString	getLocalizedDescription()
LocalizedString	getLocalizedName()
String	getName()
String	getPredicate()
default List<ShippingRate>	getShippingRatesForZone(Referenceable<Zone> zone)
Reference<TaxCategory>	getTaxCategory()
List<ZoneRate>	getZoneRates()
default List<Reference<Zone>>	getZones()
Boolean	isDefault()
static Reference<ShippingMethod>	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<ShippingMethod>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<ShippingMethod>	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

getKey

@Nullable
String getKey()

Specified by:

getKey in interface WithKey

getName

String getName()

getDescription

@Deprecated
 @Nullable
String getDescription()

Deprecated.

getLocalizedDescription

@Nullable
LocalizedString getLocalizedDescription()

getLocalizedName

@Nullable
LocalizedString getLocalizedName()

getTaxCategory

Reference<TaxCategory> getTaxCategory()

getZoneRates

List<ZoneRate> getZoneRates()

getShippingRatesForZone

default List<ShippingRate> getShippingRatesForZone(Referenceable<Zone> zone)

getZones

default List<Reference<Zone>> getZones()

isDefault

Boolean isDefault()

getPredicate

@Nullable
String getPredicate()

getCustom

@Nullable
CustomFields getCustom()

Specified by:

getCustom in interface Custom

toReference

default Reference<ShippingMethod> toReference()

Description copied from interface: Referenceable

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

Specified by:

toReference in interface Referenceable<ShippingMethod>

Specified by:

toReference in interface Resource<ShippingMethod>

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<ShippingMethod> 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<ShippingMethod> 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