com.elasticpath.xpf.connectivity.entity

Class XPFProduct

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFProduct

Direct Known Subclasses:

XPFProductBundle

public class XPFProduct
extends XPFEntity

Product Extension Point entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFProduct.XPFProductBuilder<C extends XPFProduct,B extends XPFProduct.XPFProductBuilder<C,B>>

Nested classes/interfaces inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

XPFEntity.XPFEntityBuilder<C extends XPFEntity,B extends XPFEntity.XPFEntityBuilder<C,B>>

Constructor Summary

Constructors

Modifier	Constructor and Description
	XPFProduct(@NonNull String code, @NonNull XPFEntitySupplier<Map<Locale,String>> displayNames, Instant startDate, Instant endDate, @NonNull XPFProductType productType, @NonNull Set<XPFCategory> categories, @NonNull Map<Locale,Map<String,XPFAttributeValue>> attributeValues, boolean bundle, boolean notSoldSeparately, boolean hidden, Instant expectedReleaseDate, XPFEntitySupplier<List<XPFProductSku>> productSkus, XPFBrand brand, @NonNull XPFEntitySupplier<List<XPFAgreement>> agreements)
protected	XPFProduct(XPFProduct.XPFProductBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFProduct.XPFProductBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<XPFAgreement>	getAgreements() The agreements associated with this product.
Optional<XPFAttributeValue>	getAttributeValueByKey(String key) Returns the non-localized attribute value with the passed key (case-insensitive match).
Optional<XPFAttributeValue>	getAttributeValueByKey(String key, Locale locale) Returns the attribute value with the passed key (case insensitive match) and locale.
@NonNull Map<Locale,Map<String,XPFAttributeValue>>	getAttributeValues() The attribute value map of maps keyed by Locale and then by attribute key.
XPFBrand	getBrand() The product brand.
@NonNull Set<XPFCategory>	getCategories() The categories that this product is a member of.
@NonNull String	getCode() The product code.
Optional<String>	getDisplayName(Locale locale) Get localized display name for a locale with fallback behavior.
Map<Locale,String>	getDisplayNames() Get the display names.
Instant	getEndDate() The end date of this product's availability.
Instant	getExpectedReleaseDate() The expected release date.
List<XPFProductSku>	getProductSkus() The product skus associated with this product.
@NonNull XPFProductType	getProductType() The product type.
Instant	getStartDate() The start date of this product's availability.
int	hashCode()
boolean	isBundle() Indicates if this product is a bundle.
boolean	isHidden() Indicates if this product is hidden.
boolean	isNotSoldSeparately() Indicates if this product can be sold separately.
String	toString()

Methods inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

getCustomData, getCustomDataValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPFProduct

protected XPFProduct(XPFProduct.XPFProductBuilder<?,?> b)

XPFProduct

public XPFProduct(@NonNull
                  @NonNull String code,
                  @NonNull
                  @NonNull XPFEntitySupplier<Map<Locale,String>> displayNames,
                  Instant startDate,
                  Instant endDate,
                  @NonNull
                  @NonNull XPFProductType productType,
                  @NonNull
                  @NonNull Set<XPFCategory> categories,
                  @NonNull
                  @NonNull Map<Locale,Map<String,XPFAttributeValue>> attributeValues,
                  boolean bundle,
                  boolean notSoldSeparately,
                  boolean hidden,
                  Instant expectedReleaseDate,
                  XPFEntitySupplier<List<XPFProductSku>> productSkus,
                  XPFBrand brand,
                  @NonNull
                  @NonNull XPFEntitySupplier<List<XPFAgreement>> agreements)

Method Detail

getProductSkus

@SkipSerialization(scopes={})
 @LazyLoaded
public List<XPFProductSku> getProductSkus()

The product skus associated with this product.

Returns:

the product skus

getAgreements

@LazyLoaded
public List<XPFAgreement> getAgreements()

The agreements associated with this product.

Returns:

the agreements

getDisplayNames

public Map<Locale,String> getDisplayNames()

Get the display names.

Returns:

the display name

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

getAttributeValueByKey

public Optional<XPFAttributeValue> getAttributeValueByKey(String key)

Returns the non-localized attribute value with the passed key (case-insensitive match).

Parameters:

key - the attribute key

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.

builder

public static XPFProduct.XPFProductBuilder<?,?> builder()

getCode

@NonNull
public @NonNull String getCode()

The product code.

getStartDate

public Instant getStartDate()

The start date of this product's availability.

getEndDate

public Instant getEndDate()

The end date of this product's availability.

getProductType

@NonNull
public @NonNull XPFProductType getProductType()

The product type.

getCategories

@NonNull
public @NonNull Set<XPFCategory> getCategories()

The categories that this product is a member of.

getAttributeValues

@NonNull
public @NonNull Map<Locale,Map<String,XPFAttributeValue>> getAttributeValues()

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

isBundle

public boolean isBundle()

Indicates if this product is a bundle.

isNotSoldSeparately

public boolean isNotSoldSeparately()

Indicates if this product can be sold separately.

isHidden

public boolean isHidden()

Indicates if this product is hidden.

getExpectedReleaseDate

public Instant getExpectedReleaseDate()

The expected release date.

getBrand

public XPFBrand getBrand()

The product brand.

toString

public String toString()

Overrides:

toString in class XPFEntity

equals

public boolean equals(Object o)

Overrides:

equals in class XPFEntity

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class XPFEntity

hashCode

public int hashCode()

Overrides:

hashCode in class XPFEntity