io.sphere.sdk.products

Interface Price

All Superinterfaces:

Custom, PriceLike

public interface Price
extends PriceLike

Amount that must be paid when buying goods.

A Price can have custom fields.

For construction use a PriceBuilder.

See Also:

AddPrice, ChangePrice, RemovePrice, ProductVariant.getPrices()

Method Summary

Modifier and Type	Method and Description
default boolean	equalsIgnoreId(Price price)
Reference<Channel>	getChannel()
com.neovisionaries.i18n.CountryCode	getCountry()
CustomFields	getCustom()
Reference<CustomerGroup>	getCustomerGroup()
DiscountedPrice	getDiscounted() Supplies a discount if there is any.
String	getId() The unique ID of this price.
List<PriceTier>	getTiers()
ZonedDateTime	getValidFrom()
ZonedDateTime	getValidUntil()
javax.money.MonetaryAmount	getValue()
static Price	of(BigDecimal amount, javax.money.CurrencyUnit currencyUnit)
static Price	of(javax.money.MonetaryAmount money)
static String	resourceTypeId() An identifier for this resource which supports CustomFields.
default Price	withChannel(Referenceable<Channel> channel)
default Price	withCountry(com.neovisionaries.i18n.CountryCode country)
default Price	withCustomerGroup(Referenceable<CustomerGroup> customerGroup)
default Price	withDiscounted(DiscountedPrice discounted)
default Price	withId(String id)
default Price	withValidFrom(ZonedDateTime validFrom)
default Price	withValidUntil(ZonedDateTime validUntil)
default Price	withValue(javax.money.MonetaryAmount value)

Method Detail

getChannel

@Nullable
Reference<Channel> getChannel()

Specified by:

getChannel in interface PriceLike

getCountry

@Nullable
com.neovisionaries.i18n.CountryCode getCountry()

Specified by:

getCountry in interface PriceLike

getCustom

@Nullable
CustomFields getCustom()

Specified by:

getCustom in interface Custom

Specified by:

getCustom in interface PriceLike

getCustomerGroup

@Nullable
Reference<CustomerGroup> getCustomerGroup()

Specified by:

getCustomerGroup in interface PriceLike

getDiscounted

@Nullable
DiscountedPrice getDiscounted()

Description copied from interface: PriceLike

Supplies a discount if there is any. Beware that another discount can win and in here is another discount than you expect.

Specified by:

getDiscounted in interface PriceLike

Returns:

discount data

getId

@Nullable
String getId()

Description copied from interface: PriceLike

The unique ID of this price. Only read only.

Specified by:

getId in interface PriceLike

Returns:

price id

getValidFrom

@Nullable
ZonedDateTime getValidFrom()

Specified by:

getValidFrom in interface PriceLike

getValidUntil

@Nullable
ZonedDateTime getValidUntil()

Specified by:

getValidUntil in interface PriceLike

getValue

javax.money.MonetaryAmount getValue()

Specified by:

getValue in interface PriceLike

getTiers

@Nullable
List<PriceTier> getTiers()

withCustomerGroup

default Price withCustomerGroup(@Nullable
                                Referenceable<CustomerGroup> customerGroup)

withCountry

default Price withCountry(@Nullable
                          com.neovisionaries.i18n.CountryCode country)

withChannel

default Price withChannel(@Nullable
                          Referenceable<Channel> channel)

withDiscounted

default Price withDiscounted(@Nullable
                             DiscountedPrice discounted)

withValue

default Price withValue(javax.money.MonetaryAmount value)

withValidFrom

default Price withValidFrom(ZonedDateTime validFrom)

withValidUntil

default Price withValidUntil(ZonedDateTime validUntil)

withId

default Price withId(@Nullable
                     String id)

of

static Price of(javax.money.MonetaryAmount money)

of

static Price of(BigDecimal amount,
                javax.money.CurrencyUnit currencyUnit)

equalsIgnoreId

default boolean equalsIgnoreId(Price price)

resourceTypeId

static String resourceTypeId()

An identifier for this resource which supports CustomFields.

Returns:

ID of this resource type

See Also:

TypeDraft.getResourceTypeIds(), Custom