com.elasticpath.xpf.connectivity.entity

Class XPFProduct

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFProduct

Direct Known Subclasses:

XPFProductBundle

public class XPFProduct
extends Object

Product Extension Point entity.

Field Summary

Fields

Modifier and Type	Field and Description
private @NonNull Map<Locale,Map<String,XPFAttributeValue>>	attributeValues The attribute value map of maps keyed by Locale and then by attribute key.
private boolean	bundle Indicates if this product is a bundle.
private @NonNull Set<XPFCategory>	categories The categories that this product is a member of.
private @NonNull String	code The product code.
private @NonNull Map<Locale,String>	displayNames The product display name.
private Instant	endDate The end date of this product's availability.
private boolean	hidden Indicates if this product is hidden.
private boolean	notSoldSeparately Indicates if this product can be sold separately.
private XPFEntitySupplier<List<XPFProductSku>>	productSkus The product skus associated with this product.
private @NonNull XPFProductType	productType The product type.
private Instant	startDate The start date of this product's availability.

Constructor Summary

Constructors

Constructor and Description
XPFProduct()

Method Summary

Modifier and Type	Method and Description
Optional<XPFAttributeValue>	getAttributeValueByKey(String key, Locale locale) Returns the attribute value with the passed key (case insensitive match) and locale.
Optional<String>	getDisplayName(Locale locale) Get localized display name for a locale with fallback behavior.
List<XPFProductSku>	getProductSkus() The product skus associated with this product.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

code

@NonNull
private final @NonNull String code

The product code.

displayNames

@NonNull
private final @NonNull Map<Locale,String> displayNames

The product display name.

startDate

private final Instant startDate

The start date of this product's availability.

endDate

private final Instant endDate

The end date of this product's availability.

productType

@NonNull
private final @NonNull XPFProductType productType

The product type.

categories

@NonNull
private final @NonNull Set<XPFCategory> categories

The categories that this product is a member of.

attributeValues

@NonNull
private final @NonNull Map<Locale,Map<String,XPFAttributeValue>> attributeValues

The attribute value map of maps keyed by Locale and then by attribute key.

bundle

private final boolean bundle

Indicates if this product is a bundle.

notSoldSeparately

private final boolean notSoldSeparately

Indicates if this product can be sold separately.

hidden

private final boolean hidden

Indicates if this product is hidden.

productSkus

private final XPFEntitySupplier<List<XPFProductSku>> productSkus

The product skus associated with this product.

Constructor Detail

XPFProduct

public XPFProduct()

Method Detail

getProductSkus

public List<XPFProductSku> getProductSkus()

The product skus associated with this product.

Returns:

the product skus

getAttributeValueByKey

public Optional<XPFAttributeValue> getAttributeValueByKey(String key,
                                                          Locale locale)

Returns the attribute value with the passed key (case insensitive match) and locale.

Parameters:

key - the attribute key

locale - the attribute value locale

Returns:

attribute value

getDisplayName

public Optional<String> getDisplayName(Locale locale)

Get localized display name for a locale with fallback behavior.

Parameters:

locale - The locale to get a display name for.

Returns:

The display name as Optional.