ProductWrapper (BroadleafCommerce Framework Web 4.0.0-RC3 API)

java.lang.Object
- org.broadleafcommerce.core.web.api.wrapper.BaseWrapper
- - org.broadleafcommerce.core.web.api.wrapper.ProductWrapper

All Implemented Interfaces:

APIWrapper<Product>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
```
public class ProductWrapper
extends BaseWrapper
implements APIWrapper<Product>
```
This is a JAXB wrapper around Product. User: Kelly Tisdell Date: 4/10/12

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`active`
`protected Date`	`activeEndDate`
`protected Date`	`activeStartDate`
`protected Money`	`bundleItemsRetailPrice`
`protected Money`	`bundleItemsSalePrice`
`protected List<RelatedProductWrapper>`	`crossSaleProducts`
`protected Long`	`defaultCategoryId`
`protected String`	`description`
`protected Long`	`id`
`protected String`	`longDescription`
`protected String`	`manufacturer`
`protected List<MediaWrapper>`	`media`
`protected String`	`model`
`protected String`	`name`
`protected MediaWrapper`	`primaryMedia`
`protected Integer`	`priority`
`protected List<ProductAttributeWrapper>`	`productAttributes`
`protected List<ProductOptionWrapper>`	`productOptions`
`protected String`	`promoMessage`
`protected Money`	`retailPrice`
`protected Money`	`salePrice`
`protected List<SkuBundleItemWrapper>`	`skuBundleItems`
`protected List<RelatedProductWrapper>`	`upsaleProducts`

Fields inherited from class org.broadleafcommerce.core.web.api.wrapper.BaseWrapper
context

Constructor Summary

Constructors
Constructor and Description

ProductWrapper()

Constructors
Constructor and Description
`ProductWrapper()`

Method Summary

Methods
Modifier and Type	Method and Description
`Boolean`	`getActive()`
`Date`	`getActiveEndDate()`
`Date`	`getActiveStartDate()`
`Money`	`getBundleItemsRetailPrice()`
`Money`	`getBundleItemsSalePrice()`
`List<RelatedProductWrapper>`	`getCrossSaleProducts()`
`Long`	`getDefaultCategoryId()`
`String`	`getDescription()`
`Long`	`getId()`
`String`	`getLongDescription()`
`String`	`getManufacturer()`
`List<MediaWrapper>`	`getMedia()`
`String`	`getModel()`
`String`	`getName()`
`MediaWrapper`	`getPrimaryMedia()`
`Integer`	`getPriority()`
`List<ProductAttributeWrapper>`	`getProductAttributes()`
`List<ProductOptionWrapper>`	`getProductOptions()`
`String`	`getPromoMessage()`
`Money`	`getRetailPrice()`
`Money`	`getSalePrice()`
`List<SkuBundleItemWrapper>`	`getSkuBundleItems()`
`List<RelatedProductWrapper>`	`getUpsaleProducts()`
`void`	`setActive(Boolean active)`
`void`	`setActiveEndDate(Date activeEndDate)`
`void`	`setActiveStartDate(Date activeStartDate)`
`void`	`setBundleItemsRetailPrice(Money bundleItemsRetailPrice)`
`void`	`setBundleItemsSalePrice(Money bundleItemsSalePrice)`
`void`	`setCrossSaleProducts(List<RelatedProductWrapper> crossSaleProducts)`
`void`	`setDefaultCategoryId(Long defaultCategoryId)`
`void`	`setDescription(String description)`
`void`	`setId(Long id)`
`void`	`setLongDescription(String longDescription)`
`void`	`setManufacturer(String manufacturer)`
`void`	`setMedia(List<MediaWrapper> media)`
`void`	`setModel(String model)`
`void`	`setName(String name)`
`void`	`setPrimaryMedia(MediaWrapper primaryMedia)`
`void`	`setPriority(Integer priority)`
`void`	`setProductAttributes(List<ProductAttributeWrapper> productAttributes)`
`void`	`setProductOptions(List<ProductOptionWrapper> productOptions)`
`void`	`setPromoMessage(String promoMessage)`
`void`	`setRetailPrice(Money retailPrice)`
`void`	`setSalePrice(Money salePrice)`
`void`	`setSkuBundleItems(List<SkuBundleItemWrapper> skuBundleItems)`
`void`	`setUpsaleProducts(List<RelatedProductWrapper> upsaleProducts)`
`void`	`wrapDetails(Product model, javax.servlet.http.HttpServletRequest request)`
`void`	`wrapSummary(Product model, javax.servlet.http.HttpServletRequest request)`

Methods inherited from class org.broadleafcommerce.core.web.api.wrapper.BaseWrapper
createElementWrappers, setApplicationContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id
```
protected Long id
```

name
```
protected String name
```

description
```
protected String description
```

longDescription
```
protected String longDescription
```

retailPrice
```
protected Money retailPrice
```

salePrice
```
protected Money salePrice
```

primaryMedia
```
protected MediaWrapper primaryMedia
```

active
```
protected Boolean active
```

productOptions

protected List<ProductOptionWrapper> productOptions

priority
```
protected Integer priority
```

bundleItemsRetailPrice
```
protected Money bundleItemsRetailPrice
```

bundleItemsSalePrice
```
protected Money bundleItemsSalePrice
```

activeStartDate
```
protected Date activeStartDate
```

activeEndDate
```
protected Date activeEndDate
```

manufacturer
```
protected String manufacturer
```

model
```
protected String model
```

promoMessage
```
protected String promoMessage
```

defaultCategoryId
```
protected Long defaultCategoryId
```

upsaleProducts

protected List<RelatedProductWrapper> upsaleProducts

crossSaleProducts

protected List<RelatedProductWrapper> crossSaleProducts

productAttributes

protected List<ProductAttributeWrapper> productAttributes

media
```
protected List<MediaWrapper> media
```

skuBundleItems

protected List<SkuBundleItemWrapper> skuBundleItems

Constructor Detail
- ProductWrapper
```
public ProductWrapper()
```

Method Detail
- wrapDetails
```
public void wrapDetails(Product model,
               javax.servlet.http.HttpServletRequest request)
```
  Specified by:
  
  wrapDetails in interface APIWrapper<Product>
- wrapSummary
```
public void wrapSummary(Product model,
               javax.servlet.http.HttpServletRequest request)
```
  Specified by:
  
  wrapSummary in interface APIWrapper<Product>
- getId
```
public Long getId()
```
  Returns:
  the id
- setId
```
public void setId(Long id)
```
  Parameters:
  id - the id to set
- getName
```
public String getName()
```
  Returns:
  the name
- setName
```
public void setName(String name)
```
  Parameters:
  name - the name to set
- getDescription
```
public String getDescription()
```
  Returns:
  the description
- setDescription
```
public void setDescription(String description)
```
  Parameters:
  description - the description to set
- getLongDescription
```
public String getLongDescription()
```
  Returns:
  the longDescription
- setLongDescription
```
public void setLongDescription(String longDescription)
```
  Parameters:
  longDescription - the longDescription to set
- getRetailPrice
```
public Money getRetailPrice()
```
  Returns:
  the retailPrice
- setRetailPrice
```
public void setRetailPrice(Money retailPrice)
```
  Parameters:
  retailPrice - the retailPrice to set
- getSalePrice
```
public Money getSalePrice()
```
  Returns:
  the salePrice
- setSalePrice
```
public void setSalePrice(Money salePrice)
```
  Parameters:
  salePrice - the salePrice to set
- getPrimaryMedia
```
public MediaWrapper getPrimaryMedia()
```
  Returns:
  the primaryMedia
- setPrimaryMedia
```
public void setPrimaryMedia(MediaWrapper primaryMedia)
```
  Parameters:
  primaryMedia - the primaryMedia to set
- getActive
```
public Boolean getActive()
```
  Returns:
  the active
- setActive
```
public void setActive(Boolean active)
```
  Parameters:
  active - the active to set
- getProductOptions
```
public List<ProductOptionWrapper> getProductOptions()
```
  Returns:
  the productOptions
- setProductOptions
```
public void setProductOptions(List<ProductOptionWrapper> productOptions)
```
  Parameters:
  productOptions - the productOptions to set
- getPriority
```
public Integer getPriority()
```
  Returns:
  the priority
- setPriority
```
public void setPriority(Integer priority)
```
  Parameters:
  priority - the priority to set
- getBundleItemsRetailPrice
```
public Money getBundleItemsRetailPrice()
```
  Returns:
  the bundleItemsRetailPrice
- setBundleItemsRetailPrice
```
public void setBundleItemsRetailPrice(Money bundleItemsRetailPrice)
```
  Parameters:
  bundleItemsRetailPrice - the bundleItemsRetailPrice to set
- getBundleItemsSalePrice
```
public Money getBundleItemsSalePrice()
```
  Returns:
  the bundleItemsSalePrice
- setBundleItemsSalePrice
```
public void setBundleItemsSalePrice(Money bundleItemsSalePrice)
```
  Parameters:
  bundleItemsSalePrice - the bundleItemsSalePrice to set
- getActiveStartDate
```
public Date getActiveStartDate()
```
  Returns:
  the activeStartDate
- setActiveStartDate
```
public void setActiveStartDate(Date activeStartDate)
```
  Parameters:
  activeStartDate - the activeStartDate to set
- getActiveEndDate
```
public Date getActiveEndDate()
```
  Returns:
  the activeEndDate
- setActiveEndDate
```
public void setActiveEndDate(Date activeEndDate)
```
  Parameters:
  activeEndDate - the activeEndDate to set
- getManufacturer
```
public String getManufacturer()
```
  Returns:
  the manufacturer
- setManufacturer
```
public void setManufacturer(String manufacturer)
```
  Parameters:
  manufacturer - the manufacturer to set
- getModel
```
public String getModel()
```
  Returns:
  the model
- setModel
```
public void setModel(String model)
```
  Parameters:
  model - the model to set
- getPromoMessage
```
public String getPromoMessage()
```
  Returns:
  the promoMessage
- setPromoMessage
```
public void setPromoMessage(String promoMessage)
```
  Parameters:
  promoMessage - the promoMessage to set
- getDefaultCategoryId
```
public Long getDefaultCategoryId()
```
  Returns:
  the defaultCategoryId
- setDefaultCategoryId
```
public void setDefaultCategoryId(Long defaultCategoryId)
```
  Parameters:
  defaultCategoryId - the defaultCategoryId to set
- getUpsaleProducts
```
public List<RelatedProductWrapper> getUpsaleProducts()
```
  Returns:
  the upsaleProducts
- setUpsaleProducts
```
public void setUpsaleProducts(List<RelatedProductWrapper> upsaleProducts)
```
  Parameters:
  upsaleProducts - the upsaleProducts to set
- getCrossSaleProducts
```
public List<RelatedProductWrapper> getCrossSaleProducts()
```
  Returns:
  the crossSaleProducts
- setCrossSaleProducts
```
public void setCrossSaleProducts(List<RelatedProductWrapper> crossSaleProducts)
```
  Parameters:
  crossSaleProducts - the crossSaleProducts to set
- getProductAttributes
```
public List<ProductAttributeWrapper> getProductAttributes()
```
  Returns:
  the productAttributes
- setProductAttributes
```
public void setProductAttributes(List<ProductAttributeWrapper> productAttributes)
```
  Parameters:
  productAttributes - the productAttributes to set
- getMedia
```
public List<MediaWrapper> getMedia()
```
  Returns:
  the media
- setMedia
```
public void setMedia(List<MediaWrapper> media)
```
  Parameters:
  media - the media to set
- getSkuBundleItems
```
public List<SkuBundleItemWrapper> getSkuBundleItems()
```
  Returns:
  the skuBundleItems
- setSkuBundleItems
```
public void setSkuBundleItems(List<SkuBundleItemWrapper> skuBundleItems)
```
  Parameters:
  skuBundleItems - the skuBundleItems to set

Class ProductWrapper

Field Summary

Fields inherited from class org.broadleafcommerce.core.web.api.wrapper.BaseWrapper

Constructor Summary

Method Summary

Methods inherited from class org.broadleafcommerce.core.web.api.wrapper.BaseWrapper

Methods inherited from class java.lang.Object

Field Detail

id

name

description

longDescription

retailPrice

salePrice

primaryMedia

active

productOptions

priority

bundleItemsRetailPrice

bundleItemsSalePrice

activeStartDate

activeEndDate

manufacturer

model

promoMessage

defaultCategoryId

upsaleProducts

crossSaleProducts

productAttributes

media

skuBundleItems

Constructor Detail

ProductWrapper

Method Detail

wrapDetails

wrapSummary

getId

setId

getName

setName

getDescription

setDescription

getLongDescription

setLongDescription

getRetailPrice

setRetailPrice

getSalePrice

setSalePrice

getPrimaryMedia

setPrimaryMedia

getActive

setActive

getProductOptions

setProductOptions

getPriority

setPriority

getBundleItemsRetailPrice

setBundleItemsRetailPrice

getBundleItemsSalePrice

setBundleItemsSalePrice

getActiveStartDate

setActiveStartDate

getActiveEndDate

setActiveEndDate

getManufacturer

setManufacturer

getModel

setModel

getPromoMessage

setPromoMessage

getDefaultCategoryId

setDefaultCategoryId

getUpsaleProducts

setUpsaleProducts

getCrossSaleProducts

setCrossSaleProducts

getProductAttributes

setProductAttributes

getMedia

setMedia