public class ProductApi extends ResourceSupport
Modifier and Type | Class and Description |
---|---|
static class |
ProductApi.Availability |
static class |
ProductApi.SortAttribute |
Modifier and Type | Field and Description |
---|---|
private com.google.common.collect.Multimap<java.lang.String,java.lang.String> |
attributeSelection |
private ProductApi.Availability |
availability
Identifier for displaying an availability icon.
|
private java.lang.String |
availabilityText
A custom text providing stock level / delivery period information.
|
private java.lang.String |
deliveryPeriod |
private Quantity |
deliveryWeight
Delivery weight is related to the value of the 'quantity' field above.
|
private java.lang.String |
description
Product full description.
|
private java.lang.String |
ean
European Article Number
|
private java.net.URI |
energyLabelSourceFile
Image or PDF file containing the label image supplied by the
manufacturer.
|
private java.lang.String |
energyLabelsString
Comma-separated list of energy labels applied to this product.
|
private java.lang.String |
essentialFeatures
Short description of the product's essential features
|
private java.lang.Boolean |
forSale
If true the product can be added to the shopping cart.
|
private java.util.List<Image> |
images
A list of images.
|
private java.lang.String |
manufacturer
Manufacturer / vendor
|
private java.lang.String |
manufacturerProductNumber |
private GUID |
master |
private java.lang.String |
name
Name of the product.
|
static javax.ws.rs.core.GenericType<PageEP6<ProductApi>> |
PAGE_TYPE |
private PriceInfo |
priceInfo
Pricing related information.
|
private java.net.URI |
productDataSheet
Image or PDF file containing datasheet with technical information.
|
private java.lang.Float |
productHeight |
private GUID |
productId
A unique global identifier of the product (GUID).
|
private java.lang.String |
productImage
Name of the product image
|
private java.lang.Float |
productLength |
private java.lang.String |
productNumber
'Alias' on EP6
|
private GUID |
productType |
private java.util.List<VariationIdentifier> |
productVariationSelection |
private java.lang.String |
productVariationType |
private java.lang.Float |
productWidth |
private java.util.List<java.lang.String> |
searchKeywords |
private java.net.URI |
sfUrl
Link to the StoreFront URL of the product.
|
private java.util.List<Link> |
shippingMethodsRestrictedTo
Available shipping methods.
|
private java.lang.String |
shortDescription
Product short description text, usually used in list context.
|
private java.lang.Boolean |
specialOffer
If true the product is a special offer.
|
private java.lang.Float |
stocklevel |
private java.lang.String |
title |
private java.lang.String |
upc
Universal Product Code
|
private boolean |
useSlideshow |
private java.util.List<GUID> |
variationIds |
private boolean |
visible |
Constructor and Description |
---|
ProductApi() |
Modifier and Type | Method and Description |
---|---|
com.google.common.collect.Multimap<java.lang.String,java.lang.String> |
getAttributeSelection() |
ProductApi.Availability |
getAvailability() |
java.lang.String |
getAvailabilityText()
A custom text providing stock level / delivery period information
|
java.lang.String |
getDeliveryPeriod() |
Quantity |
getDeliveryWeight()
Delivery weight
|
java.lang.String |
getDescription()
Description of the product
|
java.lang.String |
getEan() |
java.net.URI |
getEnergyLabelSourceFile() |
java.lang.String |
getEnergyLabelsString() |
java.lang.String |
getEssentialFeatures() |
java.util.List<Image> |
getImages()
A list of
Image s |
java.lang.String |
getManufacturer() |
java.lang.String |
getManufacturerProductNumber() |
GUID |
getMaster() |
java.lang.String |
getName()
Name of the product
|
PriceInfo |
getPriceInfo()
Pricing related information
|
java.net.URI |
getProductDataSheet() |
java.lang.Float |
getProductHeight() |
GUID |
getProductId()
A unique identifier of the product
|
java.lang.String |
getProductImage()
Name of the product image
|
java.lang.Float |
getProductLength() |
java.lang.String |
getProductNumber() |
GUID |
getProductType() |
java.util.List<VariationIdentifier> |
getProductVariationSelection() |
java.lang.String |
getProductVariationType() |
java.lang.Float |
getProductWidth() |
java.util.List<java.lang.String> |
getSearchKeywords() |
java.net.URI |
getSfUrl() |
java.util.List<Link> |
getShippingMethodsRestrictedTo()
Available shipping methods.
|
java.lang.String |
getShortDescription()
Short description text, usually used in list context.
|
java.lang.Float |
getStocklevel() |
java.lang.String |
getTitle() |
java.lang.String |
getUpc() |
java.util.List<GUID> |
getVariationIds() |
java.lang.Boolean |
isForSale()
Used to tell the client that product can be added to the cart Master
products cannot be purchased
|
java.lang.Boolean |
isSpecialOffer() |
boolean |
isUseSlideshow() |
boolean |
isVisible() |
void |
setAttributeSelection(com.google.common.collect.Multimap<java.lang.String,java.lang.String> attributeSelection) |
void |
setAvailability(ProductApi.Availability availability) |
void |
setAvailabilityText(java.lang.String availabilityText) |
void |
setDeliveryPeriod(java.lang.String deliveryPeriod) |
void |
setDeliveryWeight(Quantity deliveryWeight) |
void |
setDescription(java.lang.String description) |
void |
setEan(java.lang.String ean) |
void |
setEnergyLabelSourceFile(java.net.URI energyLabelSourceFile) |
void |
setEnergyLabelsString(java.lang.String energyLabelsString) |
void |
setEssentialFeatures(java.lang.String essentialFeatures) |
void |
setForSale(java.lang.Boolean forSale) |
void |
setImages(java.util.List<Image> images) |
void |
setManufacturer(java.lang.String manufacturer) |
void |
setManufacturerProductNumber(java.lang.String manufacturerProductNumber) |
void |
setMaster(GUID master) |
void |
setName(java.lang.String name) |
void |
setPriceInfo(PriceInfo priceInfo) |
void |
setProductDataSheet(java.net.URI productDataSheet) |
void |
setProductHeight(java.lang.Float productHeight) |
void |
setProductId(GUID productId) |
void |
setProductImage(java.lang.String productImage) |
void |
setProductLength(java.lang.Float productLength) |
void |
setProductNumber(java.lang.String productNumber) |
void |
setProductType(GUID productType) |
void |
setProductVariationSelection(java.util.List<VariationIdentifier> productVariationSelection) |
void |
setProductVariationType(java.lang.String productVariationType) |
void |
setProductWidth(java.lang.Float productWidth) |
void |
setSearchKeywords(java.util.List<java.lang.String> searchKeywords) |
void |
setSfUrl(java.net.URI sfUrl) |
void |
setShippingMethodsRestrictedTo(java.util.List<Link> shippingMethodsRestrictedTo) |
void |
setShortDescription(java.lang.String shortDescription) |
void |
setSpecialOffer(java.lang.Boolean specialOffer) |
void |
setStocklevel(java.lang.Float stocklevel) |
void |
setTitle(java.lang.String title) |
void |
setUpc(java.lang.String upc) |
void |
setUpcEan(java.lang.String upcEan) |
void |
setUseSlideshow(boolean useSlideshow) |
void |
setVariationIds(java.util.List<GUID> variationIds) |
void |
setVisible(boolean visible) |
add, add, equals, getLink, getLinks, getSelfLinkUri, hashCode, hasLink, hasLinks, removeLinks, toString
public static javax.ws.rs.core.GenericType<PageEP6<ProductApi>> PAGE_TYPE
private GUID productId
private java.lang.String name
private boolean visible
private java.lang.String productVariationType
private java.lang.String manufacturerProductNumber
private java.lang.Float productLength
private java.lang.Float productWidth
private java.lang.Float productHeight
private java.util.List<VariationIdentifier> productVariationSelection
private java.lang.String shortDescription
private java.lang.String deliveryPeriod
private java.lang.String description
private java.lang.String title
private java.lang.String productImage
private java.util.List<Image> images
private PriceInfo priceInfo
private java.lang.Boolean forSale
A master product cannot be purchased.
private java.lang.Boolean specialOffer
private Quantity deliveryWeight
private java.util.List<Link> shippingMethodsRestrictedTo
Links to the available Shipping Method resources otherwise. This list is not serialized in case of null.
private java.lang.String availabilityText
private ProductApi.Availability availability
Possible values: OnStock, WarnStock, OutStock
private GUID productType
private java.util.List<GUID> variationIds
private boolean useSlideshow
private GUID master
private com.google.common.collect.Multimap<java.lang.String,java.lang.String> attributeSelection
private java.lang.String energyLabelsString
Can be one or two values. If two values are returned the first value is the best energy label, and the second is the worst.
private java.net.URI energyLabelSourceFile
private java.net.URI productDataSheet
private java.net.URI sfUrl
private java.lang.String productNumber
private java.lang.String manufacturer
private java.lang.String upc
private java.lang.String ean
private java.lang.String essentialFeatures
private java.util.List<java.lang.String> searchKeywords
private java.lang.Float stocklevel
public GUID getProductId()
public void setProductId(GUID productId)
public java.lang.String getName()
public void setName(java.lang.String name)
public boolean isVisible()
public void setVisible(boolean visible)
public java.lang.String getShortDescription()
public void setShortDescription(java.lang.String shortDescription)
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
public java.lang.String getDeliveryPeriod()
public void setDeliveryPeriod(java.lang.String deliveryPeriod)
public java.lang.String getProductImage()
public void setProductImage(java.lang.String productImage)
public void setImages(java.util.List<Image> images)
public PriceInfo getPriceInfo()
public void setPriceInfo(PriceInfo priceInfo)
public Quantity getDeliveryWeight()
public void setDeliveryWeight(Quantity deliveryWeight)
public java.util.List<Link> getShippingMethodsRestrictedTo()
public void setShippingMethodsRestrictedTo(java.util.List<Link> shippingMethodsRestrictedTo)
public java.lang.String getAvailabilityText()
public void setAvailabilityText(java.lang.String availabilityText)
public ProductApi.Availability getAvailability()
public void setAvailability(ProductApi.Availability availability)
public java.lang.Boolean isForSale()
public void setForSale(java.lang.Boolean forSale)
public java.lang.Boolean isSpecialOffer()
public void setSpecialOffer(java.lang.Boolean specialOffer)
public java.util.List<GUID> getVariationIds()
public void setVariationIds(java.util.List<GUID> variationIds)
public void setAttributeSelection(com.google.common.collect.Multimap<java.lang.String,java.lang.String> attributeSelection)
public com.google.common.collect.Multimap<java.lang.String,java.lang.String> getAttributeSelection()
public GUID getProductType()
public void setProductType(GUID productType)
public boolean isUseSlideshow()
public void setUseSlideshow(boolean useSlideshow)
public GUID getMaster()
public void setMaster(GUID master)
public java.lang.String getEnergyLabelsString()
public void setEnergyLabelsString(java.lang.String energyLabelsString)
public java.net.URI getEnergyLabelSourceFile()
public void setEnergyLabelSourceFile(java.net.URI energyLabelSourceFile)
public java.net.URI getProductDataSheet()
public void setProductDataSheet(java.net.URI productDataSheet)
public java.net.URI getSfUrl()
public void setSfUrl(java.net.URI sfUrl)
public java.lang.String getProductNumber()
public void setProductNumber(java.lang.String productNumber)
public java.lang.String getManufacturer()
public void setManufacturer(java.lang.String manufacturer)
public void setUpcEan(java.lang.String upcEan)
public java.lang.String getUpc()
public void setUpc(java.lang.String upc)
public java.lang.String getEan()
public void setEan(java.lang.String ean)
public java.lang.String getEssentialFeatures()
public void setEssentialFeatures(java.lang.String essentialFeatures)
public java.util.List<java.lang.String> getSearchKeywords()
public void setSearchKeywords(java.util.List<java.lang.String> searchKeywords)
public java.lang.String getProductVariationType()
public void setProductVariationType(java.lang.String productVariationType)
public java.util.List<VariationIdentifier> getProductVariationSelection()
public void setProductVariationSelection(java.util.List<VariationIdentifier> productVariationSelection)
public java.lang.String getManufacturerProductNumber()
public void setManufacturerProductNumber(java.lang.String manufacturerProductNumber)
public java.lang.Float getProductLength()
public void setProductLength(java.lang.Float productLength)
public java.lang.Float getProductWidth()
public void setProductWidth(java.lang.Float productWidth)
public java.lang.Float getProductHeight()
public void setProductHeight(java.lang.Float productHeight)
public java.lang.Float getStocklevel()
public void setStocklevel(java.lang.Float stocklevel)
public java.lang.String getTitle()
public void setTitle(java.lang.String title)