com.konakartadmin.app
Class AdminProduct

java.lang.Object
  extended by com.konakartadmin.app.AdminProduct
All Implemented Interfaces:
AdminObjectIf

public class AdminProduct
extends java.lang.Object
implements AdminObjectIf

Product object for the Admin App


Field Summary
private  AdminProductAttribute[] attributes
          Array of attributes
private  AdminBookableProduct bookableProd
          Bookable Product
private  int bundledProdQuantity
          bundledProdQuantity - The number of times that this product appears in the bundle
private  java.lang.Boolean canOrderWhenNotInStock
          If null then we use the global value set by the config variable STOCK_ALLOW_CHECKOUT.
private  AdminCategory[] categories
          category
private  int categoryId
          categoryId
private  java.lang.String comparison
          comparison
private  java.lang.String contentType
          contentType: Valid for Digital Products
private  java.lang.String custom1
          custom field
private  java.lang.String custom10
          custom field
private  java.math.BigDecimal custom1Dec
          custom field
private  int custom1Int
          custom field
private  java.lang.String custom2
          custom field
private  java.math.BigDecimal custom2Dec
          custom field
private  int custom2Int
          custom field
private  java.lang.String custom3
          custom field
private  java.lang.String custom4
          custom field
private  java.lang.String custom5
          custom field
private  java.lang.String custom6
          custom field
private  java.lang.String custom7
          custom field
private  java.lang.String custom8
          custom field
private  java.lang.String custom9
          custom field
private  AdminProdAttrDesc[] customAttrArray
           
private  java.lang.String customAttrs
          Custom attributes
private  java.util.Date dateAdded
          dateAdded
private  java.util.Date dateAvailable
          dateAvailable
private  java.util.Date dateLastModified
          dateLastModifies
private  java.lang.String description
          description
private  AdminProductDescription[] descriptions
          Array of product descriptions
private  java.lang.String encodedOptionValues
          encodedOptionValues 3{5}4{1} which means product_options of id==3 and product_options_values of id==5 followed by product_options of id==4 and product_options_values of id==1.
private  java.util.Date expiryDate
          expiryDate
private  java.math.BigDecimal extPrice0
          External attributes
private  java.math.BigDecimal extPrice1
           
private  java.math.BigDecimal extPrice2
           
private  java.math.BigDecimal extPrice3
           
private  java.lang.Integer extQuantity
          extQuantity
private  java.lang.String filePath
          filePath: Valid for digital products
private  java.lang.String formattedPriceExTax
          Formatted price for use in UI
private  java.lang.String formattedPriceIncTax
          Formatted price for use in UI
private  java.lang.String formattedSpecialPriceExTax
          Formatted price for use in UI
private  java.lang.String formattedSpecialPriceIncTax
          Formatted price for use in UI
private  int id
          id
private  java.lang.String image
          image
private  java.lang.String image2
          image2
private  java.lang.String image3
          image3
private  java.lang.String image4
          image4
private  boolean indexAttachment
          If the product is a digital download and the SOLR search engine is enabled, then the attachment is indexed within the search engine when this boolean is set.
private  byte invisible
          invisible
private  AdminManufacturer manufacturer
          manufacturer
private  int manufacturerId
          manufacturerId
private  java.lang.String manufacturerName
          manufacturerName
private  java.util.Date masterProdDate
          When copies of the same product exist in different stores, this is the last modified date of the master product.
private  int maxDownloadDays
          Maximum number of days a product can be downloaded in the case of digital downloads.
private  int maxNumDownloads
          Maximum number of downloads in the case of digital download products.
private  AdminMiscItem[] miscItems
          Miscellaneous Items
private  java.lang.String model
          model
private  java.lang.String name
          name
private  int numberReviews
          numberReviews
private  AdminOption[] opts
          Array of options - opts
private  int ordered
          Number of times it has been ordered
private  AdminPaymentSchedule paymentSchedule
          Payment Schedule
private  int paymentScheduleId
          Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.
private  java.math.BigDecimal price0
           
private  java.math.BigDecimal price1
           
private  java.math.BigDecimal price2
           
private  java.math.BigDecimal price3
           
private  java.math.BigDecimal priceExTax
          price excluding tax
private  int priceId
          Determines which price to be used in certain engine modes
private  java.math.BigDecimal priceIncTax
          price including tax
private  AdminProductQuantity[] productQuantities
          An array of productQuantity objects that define different quantities for different options
private  int quantity
          quantity
private  java.math.BigDecimal rating
          Rating
private  java.lang.String sku
          SKU
private  java.util.Date specialExpiryDate
           
private  int specialId
           
private  java.math.BigDecimal specialPriceExTax
          specialPrice excluding tax
private  java.math.BigDecimal specialPriceIncTax
          specialPrice including tax
private  java.util.Date specialStartDate
           
private  byte specialStatus
           
private  byte status
          status
private  int stockReorderLevel
          Product needs to be reordered when the stock hits this level.
private  java.lang.String storeCustom1
          Custom field with unique value for a store when in multi-store shared products mode
private  java.lang.String storeCustom2
          Custom field with unique value for a store when in multi-store shared products mode
private  java.lang.String storeCustom3
          Custom field with unique value for a store when in multi-store shared products mode
private  int taxClassId
          taxClassId
private  int templateId
          Id of custom attribute template
private  java.lang.String templateName
          Name of custom attribute template
private  AdminTierPrice[] tierPrices
          Array of tier prices
private  int type
          product type.
private  java.lang.String url
          url
private  java.lang.String uuid
          A unique identifier to identify products that exist in different stores in different versions.
private  int viewedCount
          viewedCount
private  java.math.BigDecimal weight
          weight
 
Constructor Summary
AdminProduct()
          Constructor
AdminProduct(com.workingdogs.village.Record vr, org.apache.torque.util.Criteria c)
          Instantiates the attributes of the Product object from a Record object
 
Method Summary
 int calculateProductQuantity()
          Returns the quantity of a product.
 AdminProductAttribute[] getAttributes()
           
 AdminBookableProduct getBookableProd()
           
 int getBundledProdQuantity()
          The number of times that this product appears in the bundle
 java.lang.Boolean getCanOrderWhenNotInStock()
           
 AdminCategory[] getCategories()
           
 int getCategoryId()
           
 java.lang.String getComparison()
           
 java.lang.String getContentType()
           
 java.lang.String getCustom1()
           
 java.lang.String getCustom10()
           
 java.math.BigDecimal getCustom1Dec()
           
 int getCustom1Int()
           
 java.lang.String getCustom2()
           
 java.math.BigDecimal getCustom2Dec()
           
 int getCustom2Int()
           
 java.lang.String getCustom3()
           
 java.lang.String getCustom4()
           
 java.lang.String getCustom5()
           
 java.lang.String getCustom6()
           
 java.lang.String getCustom7()
           
 java.lang.String getCustom8()
           
 java.lang.String getCustom9()
           
 AdminProdAttrDesc[] getCustomAttrArray()
          An array of AdminProdAttrDesc objects
 java.lang.String getCustomAttrs()
          Contains the custom attributes in XML format
 java.util.Date getDateAdded()
           
 java.util.Date getDateAvailable()
           
 java.util.Date getDateLastModified()
           
 java.lang.String getDescription()
           
 AdminProductDescription[] getDescriptions()
           
 java.lang.String getEncodedOptionValues()
           
 java.util.Date getExpiryDate()
           
 java.math.BigDecimal getExtPrice0()
           
 java.math.BigDecimal getExtPrice1()
           
 java.math.BigDecimal getExtPrice2()
           
 java.math.BigDecimal getExtPrice3()
           
 java.lang.Integer getExtQuantity()
           
 java.lang.String getFilePath()
           
 java.lang.String getFormattedPriceExTax()
           
 java.lang.String getFormattedPriceIncTax()
           
 java.lang.String getFormattedSpecialPriceExTax()
           
 java.lang.String getFormattedSpecialPriceIncTax()
           
 int getId()
           
 java.lang.String getImage()
           
 java.lang.String getImage2()
           
 java.lang.String getImage3()
           
 java.lang.String getImage4()
           
 byte getInvisible()
           
 AdminManufacturer getManufacturer()
           
 int getManufacturerId()
           
 java.lang.String getManufacturerName()
           
 java.util.Date getMasterProdDate()
          When copies of the same product exist in different stores, this is the last modified date of the master product.
 int getMaxDownloadDays()
          Maximum number of days a product can be downloaded in the case of digital downloads.
 int getMaxNumDownloads()
          Maximum number of downloads in the case of digital download products.
 AdminMiscItem[] getMiscItems()
          Returns the array of Miscellaneous Items associated with this product.
 java.lang.String getModel()
           
 java.lang.String getName()
           
 int getNumberReviews()
           
 AdminOption[] getOpts()
           
 int getOrdered()
           
 AdminPaymentSchedule getPaymentSchedule()
          A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.
 int getPaymentScheduleId()
          Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.
 java.math.BigDecimal getPrice0()
           
 java.math.BigDecimal getPrice1()
           
 java.math.BigDecimal getPrice2()
           
 java.math.BigDecimal getPrice3()
           
 java.math.BigDecimal getPriceExTax()
           
 int getPriceId()
           
 java.math.BigDecimal getPriceIncTax()
           
 AdminProductQuantity[] getProductQuantities()
           
 int getQuantity()
           
 java.math.BigDecimal getRating()
           
 java.lang.String getSku()
           
 java.util.Date getSpecialExpiryDate()
           
 int getSpecialId()
           
 java.math.BigDecimal getSpecialPriceExTax()
           
 java.math.BigDecimal getSpecialPriceIncTax()
           
 java.util.Date getSpecialStartDate()
           
 byte getSpecialStatus()
           
 byte getStatus()
           
 int getStockReorderLevel()
          Product needs to be reordered when the stock hits this level.
 java.lang.String getStoreCustom1()
          Custom field with unique value for a store when in multi-store shared products mode
 java.lang.String getStoreCustom2()
          Custom field with unique value for a store when in multi-store shared products mode
 java.lang.String getStoreCustom3()
          Custom field with unique value for a store when in multi-store shared products mode
 int getTaxClassId()
           
 int getTemplateId()
           
 java.lang.String getTemplateName()
           
 AdminTierPrice[] getTierPrices()
           
 int getType()
           
 java.lang.String getUrl()
           
 java.lang.String getUuid()
          A unique identifier to identify products that exist in different stores in different versions.
 int getViewedCount()
           
 java.math.BigDecimal getWeight()
           
 boolean isIndexAttachment()
           
 void setAttributes(AdminProductAttribute[] attributes)
           
 void setBookableProd(AdminBookableProduct bookableProd)
           
 void setBundledProdQuantity(int bundledProdQuantity)
          The number of times that this product appears in the bundle
 void setCanOrderWhenNotInStock(java.lang.Boolean canOrderWhenNotInStock)
           
 void setCategories(AdminCategory[] categories)
           
 void setCategoryId(int categoryId)
           
 void setComparison(java.lang.String comparison)
           
 void setContentType(java.lang.String contentType)
           
 void setCustom1(java.lang.String custom1)
           
 void setCustom10(java.lang.String custom10)
           
 void setCustom1Dec(java.math.BigDecimal custom1Dec)
           
 void setCustom1Int(int custom1Int)
           
 void setCustom2(java.lang.String custom2)
           
 void setCustom2Dec(java.math.BigDecimal custom2Dec)
           
 void setCustom2Int(int custom2Int)
           
 void setCustom3(java.lang.String custom3)
           
 void setCustom4(java.lang.String custom4)
           
 void setCustom5(java.lang.String custom5)
           
 void setCustom6(java.lang.String custom6)
           
 void setCustom7(java.lang.String custom7)
           
 void setCustom8(java.lang.String custom8)
           
 void setCustom9(java.lang.String custom9)
           
 void setCustomAttrArray(AdminProdAttrDesc[] customAttrArray)
          An array of AdminProdAttrDesc objects
 void setCustomAttrs(java.lang.String customAttrs)
          Contains the custom attributes in XML format
 void setDateAdded(java.util.Date dateAdded)
           
 void setDateAvailable(java.util.Date dateAvailable)
           
 void setDateLastModified(java.util.Date dateLastModified)
           
 void setDescription(java.lang.String description)
           
 void setDescriptions(AdminProductDescription[] descriptions)
           
 void setEncodedOptionValues(java.lang.String encodedOptionValues)
           
 void setExpiryDate(java.util.Date expiryDate)
           
 void setExtPrice0(java.math.BigDecimal extPrice0)
           
 void setExtPrice1(java.math.BigDecimal extPrice1)
           
 void setExtPrice2(java.math.BigDecimal extPrice2)
           
 void setExtPrice3(java.math.BigDecimal extPrice3)
           
 void setExtQuantity(java.lang.Integer extQuantity)
           
 void setFilePath(java.lang.String filePath)
           
 void setFormattedPriceExTax(java.lang.String formattedPriceExTax)
           
 void setFormattedPriceIncTax(java.lang.String formattedPriceIncTax)
           
 void setFormattedSpecialPriceExTax(java.lang.String formattedSpecialPriceExTax)
           
 void setFormattedSpecialPriceIncTax(java.lang.String formattedSpecialPriceIncTax)
           
 void setId(int id)
           
 void setImage(java.lang.String image)
           
 void setImage2(java.lang.String image2)
           
 void setImage3(java.lang.String image3)
           
 void setImage4(java.lang.String image4)
           
 void setIndexAttachment(boolean indexAttachment)
           
 void setInvisible(byte invisible)
           
 void setManufacturer(AdminManufacturer manufacturer)
           
 void setManufacturerId(int manufacturerId)
           
 void setManufacturerName(java.lang.String manufacturerName)
           
 void setMasterProdDate(java.util.Date masterProdDate)
          When copies of the same product exist in different stores, this is the last modified date of the master product.
 void setMaxDownloadDays(int maxDownloadDays)
          Maximum number of days a product can be downloaded in the case of digital downloads.
 void setMaxNumDownloads(int maxNumDownloads)
          Maximum number of downloads in the case of digital download products.
 void setMiscItems(AdminMiscItem[] miscItems)
           
 void setModel(java.lang.String model)
           
 void setName(java.lang.String name)
           
 void setNumberReviews(int numberReviews)
           
 void setOpts(AdminOption[] opts)
           
 void setOrdered(int ordered)
           
 void setPaymentSchedule(AdminPaymentSchedule paymentSchedule)
          A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.
 void setPaymentScheduleId(int paymentScheduleId)
          Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.
 void setPrice0(java.math.BigDecimal price0)
           
 void setPrice1(java.math.BigDecimal price1)
           
 void setPrice2(java.math.BigDecimal price2)
           
 void setPrice3(java.math.BigDecimal price3)
           
 void setPriceExTax(java.math.BigDecimal priceExTax)
           
 void setPriceId(int priceId)
           
 void setPriceIncTax(java.math.BigDecimal priceIncTax)
           
 void setProductQuantities(AdminProductQuantity[] productQuantities)
           
 void setQuantity(int quantity)
           
 void setRating(java.math.BigDecimal rating)
           
 void setSku(java.lang.String sku)
           
 void setSpecialExpiryDate(java.util.Date specialExpiryDate)
           
 void setSpecialId(int specialId)
           
 void setSpecialPriceExTax(java.math.BigDecimal specialPriceExTax)
           
 void setSpecialPriceIncTax(java.math.BigDecimal specialPriceIncTax)
           
 void setSpecialStartDate(java.util.Date specialStartDate)
           
 void setSpecialStatus(byte specialStatus)
           
 void setStatus(byte status)
           
 void setStockReorderLevel(int stockReorderLevel)
          Product needs to be reordered when the stock hits this level.
 void setStoreCustom1(java.lang.String storeCustom1)
          Custom field with unique value for a store when in multi-store shared products mode
 void setStoreCustom2(java.lang.String storeCustom2)
          Custom field with unique value for a store when in multi-store shared products mode
 void setStoreCustom3(java.lang.String storeCustom3)
          Custom field with unique value for a store when in multi-store shared products mode
 void setTaxClassId(int taxClassId)
           
 void setTemplateId(int templateId)
           
 void setTemplateName(java.lang.String templateName)
           
 void setTierPrices(AdminTierPrice[] tierPrices)
           
 void setType(int type)
           
 void setUrl(java.lang.String url)
           
 void setUuid(java.lang.String uuid)
          A unique identifier to identify products that exist in different stores in different versions.
 void setViewedCount(int viewedCount)
           
 void setWeight(java.math.BigDecimal weight)
           
 java.lang.String toString()
           
 java.lang.String toStringBrief()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

id

private int id
id


quantity

private int quantity
quantity


extQuantity

private java.lang.Integer extQuantity
extQuantity


bundledProdQuantity

private int bundledProdQuantity
bundledProdQuantity - The number of times that this product appears in the bundle


model

private java.lang.String model
model


image

private java.lang.String image
image


image2

private java.lang.String image2
image2


image3

private java.lang.String image3
image3


image4

private java.lang.String image4
image4


priceExTax

private java.math.BigDecimal priceExTax
price excluding tax


formattedPriceExTax

private java.lang.String formattedPriceExTax
Formatted price for use in UI


specialPriceExTax

private java.math.BigDecimal specialPriceExTax
specialPrice excluding tax


formattedSpecialPriceExTax

private java.lang.String formattedSpecialPriceExTax
Formatted price for use in UI


priceIncTax

private java.math.BigDecimal priceIncTax
price including tax


formattedPriceIncTax

private java.lang.String formattedPriceIncTax
Formatted price for use in UI


specialPriceIncTax

private java.math.BigDecimal specialPriceIncTax
specialPrice including tax


formattedSpecialPriceIncTax

private java.lang.String formattedSpecialPriceIncTax
Formatted price for use in UI


dateAvailable

private java.util.Date dateAvailable
dateAvailable


dateAdded

private java.util.Date dateAdded
dateAdded


expiryDate

private java.util.Date expiryDate
expiryDate


dateLastModified

private java.util.Date dateLastModified
dateLastModifies


weight

private java.math.BigDecimal weight
weight


status

private byte status
status


invisible

private byte invisible
invisible


name

private java.lang.String name
name


manufacturerName

private java.lang.String manufacturerName
manufacturerName


manufacturerId

private int manufacturerId
manufacturerId


manufacturer

private AdminManufacturer manufacturer
manufacturer


categoryId

private int categoryId
categoryId


sku

private java.lang.String sku
SKU


categories

private AdminCategory[] categories
category


description

private java.lang.String description
description


comparison

private java.lang.String comparison
comparison


url

private java.lang.String url
url


viewedCount

private int viewedCount
viewedCount


numberReviews

private int numberReviews
numberReviews


taxClassId

private int taxClassId
taxClassId


opts

private AdminOption[] opts
Array of options - opts


ordered

private int ordered
Number of times it has been ordered


descriptions

private AdminProductDescription[] descriptions
Array of product descriptions


attributes

private AdminProductAttribute[] attributes
Array of attributes


specialExpiryDate

private java.util.Date specialExpiryDate

specialStartDate

private java.util.Date specialStartDate

specialStatus

private byte specialStatus

specialId

private int specialId

productQuantities

private AdminProductQuantity[] productQuantities
An array of productQuantity objects that define different quantities for different options


filePath

private java.lang.String filePath
filePath: Valid for digital products


bookableProd

private AdminBookableProduct bookableProd
Bookable Product


contentType

private java.lang.String contentType
contentType: Valid for Digital Products


type

private int type
product type.


templateId

private int templateId
Id of custom attribute template


templateName

private java.lang.String templateName
Name of custom attribute template


customAttrs

private java.lang.String customAttrs
Custom attributes


customAttrArray

private AdminProdAttrDesc[] customAttrArray

custom1

private java.lang.String custom1
custom field


custom2

private java.lang.String custom2
custom field


custom3

private java.lang.String custom3
custom field


custom4

private java.lang.String custom4
custom field


custom5

private java.lang.String custom5
custom field


custom6

private java.lang.String custom6
custom field


custom7

private java.lang.String custom7
custom field


custom8

private java.lang.String custom8
custom field


custom9

private java.lang.String custom9
custom field


custom10

private java.lang.String custom10
custom field


custom1Int

private int custom1Int
custom field


custom2Int

private int custom2Int
custom field


custom1Dec

private java.math.BigDecimal custom1Dec
custom field


custom2Dec

private java.math.BigDecimal custom2Dec
custom field


storeCustom1

private java.lang.String storeCustom1
Custom field with unique value for a store when in multi-store shared products mode


storeCustom2

private java.lang.String storeCustom2
Custom field with unique value for a store when in multi-store shared products mode


storeCustom3

private java.lang.String storeCustom3
Custom field with unique value for a store when in multi-store shared products mode


price0

private java.math.BigDecimal price0

price1

private java.math.BigDecimal price1

price2

private java.math.BigDecimal price2

price3

private java.math.BigDecimal price3

encodedOptionValues

private java.lang.String encodedOptionValues
encodedOptionValues 3{5}4{1} which means product_options of id==3 and product_options_values of id==5 followed by product_options of id==4 and product_options_values of id==1.


maxNumDownloads

private int maxNumDownloads
Maximum number of downloads in the case of digital download products. Defaults to -1 in order to pick up the value in the DD_MAX_DOWNLOADS config variable.


maxDownloadDays

private int maxDownloadDays
Maximum number of days a product can be downloaded in the case of digital downloads. Defaults to -1 in order to pick up the value in the DD_MAX_DOWNLOAD_DAYS config variable.


stockReorderLevel

private int stockReorderLevel
Product needs to be reordered when the stock hits this level. Defaults to -1 in order to pick up the value in the STOCK_REORDER_LEVEL config variable.


canOrderWhenNotInStock

private java.lang.Boolean canOrderWhenNotInStock
If null then we use the global value set by the config variable STOCK_ALLOW_CHECKOUT. If the value isn't null, then it overrides the global value.


priceId

private int priceId
Determines which price to be used in certain engine modes


indexAttachment

private boolean indexAttachment
If the product is a digital download and the SOLR search engine is enabled, then the attachment is indexed within the search engine when this boolean is set. Currently it functions for txt and pdf attachments.


paymentScheduleId

private int paymentScheduleId
Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.


rating

private java.math.BigDecimal rating
Rating


paymentSchedule

private AdminPaymentSchedule paymentSchedule
Payment Schedule


tierPrices

private AdminTierPrice[] tierPrices
Array of tier prices


extPrice0

private java.math.BigDecimal extPrice0
External attributes


extPrice1

private java.math.BigDecimal extPrice1

extPrice2

private java.math.BigDecimal extPrice2

extPrice3

private java.math.BigDecimal extPrice3

miscItems

private AdminMiscItem[] miscItems
Miscellaneous Items


masterProdDate

private java.util.Date masterProdDate
When copies of the same product exist in different stores, this is the last modified date of the master product. It is used to determine whether a store has the latest version of the product data.


uuid

private java.lang.String uuid
A unique identifier to identify products that exist in different stores in different versions. Used when using stores to contain pre-production product data.

Constructor Detail

AdminProduct

public AdminProduct()
Constructor


AdminProduct

public AdminProduct(com.workingdogs.village.Record vr,
                    org.apache.torque.util.Criteria c)
             throws com.workingdogs.village.DataSetException
Instantiates the attributes of the Product object from a Record object

Parameters:
vr - Record containing data
c - Criteria containing column names
Throws:
com.workingdogs.village.DataSetException
Method Detail

toString

public java.lang.String toString()
Specified by:
toString in interface AdminObjectIf
Overrides:
toString in class java.lang.Object
Returns:
Returns a string containing the attributes of the Product object and those of its Options.

toStringBrief

public java.lang.String toStringBrief()
Returns:
Returns a string containing selected attributes of the Product object

calculateProductQuantity

public int calculateProductQuantity()
Returns the quantity of a product. Where there are product options this calculates an overall product quantity which is defined to be the sum of all the quantities of the product options.

Returns:
the calculated quantity for the product

getTaxClassId

public int getTaxClassId()
Returns:
Returns the taxClassId.

setTaxClassId

public void setTaxClassId(int taxClassId)
Parameters:
taxClassId - The taxClassId to set.

getManufacturerName

public java.lang.String getManufacturerName()
Returns:
Returns the manufacturerName.

setManufacturerName

public void setManufacturerName(java.lang.String manufacturerName)
Parameters:
manufacturerName - The manufacturerName to set.

getDescription

public java.lang.String getDescription()
Returns:
Returns the description.

setDescription

public void setDescription(java.lang.String description)
Parameters:
description - The description to set.

getId

public int getId()
Specified by:
getId in interface AdminObjectIf
Returns:
Returns the id.

setId

public void setId(int id)
Specified by:
setId in interface AdminObjectIf
Parameters:
id - The id to set.

getImage

public java.lang.String getImage()
Returns:
Returns the image.

setImage

public void setImage(java.lang.String image)
Parameters:
image - The image to set.

getModel

public java.lang.String getModel()
Returns:
Returns the model.

setModel

public void setModel(java.lang.String model)
Parameters:
model - The model to set.

getName

public java.lang.String getName()
Returns:
Returns the name.

setName

public void setName(java.lang.String name)
Parameters:
name - The name to set.

getOpts

public AdminOption[] getOpts()
Returns:
Returns the opts.

setOpts

public void setOpts(AdminOption[] opts)
Parameters:
opts - The opts to set.

getQuantity

public int getQuantity()
Returns:
Returns the quantity.

setQuantity

public void setQuantity(int quantity)
Parameters:
quantity - The quantity to set.

getStatus

public byte getStatus()
Returns:
Returns the status.

setStatus

public void setStatus(byte status)
Parameters:
status - The status to set.

getUrl

public java.lang.String getUrl()
Returns:
Returns the url.

setUrl

public void setUrl(java.lang.String url)
Parameters:
url - The url to set.

getViewedCount

public int getViewedCount()
Returns:
Returns the viewedCount.

setViewedCount

public void setViewedCount(int viewedCount)
Parameters:
viewedCount - The viewedCount to set.

getWeight

public java.math.BigDecimal getWeight()
Returns:
Returns the weight.

setWeight

public void setWeight(java.math.BigDecimal weight)
Parameters:
weight - The weight to set.

getNumberReviews

public int getNumberReviews()
Returns:
Returns the numberReviews.

setNumberReviews

public void setNumberReviews(int numberReviews)
Parameters:
numberReviews - The numberReviews to set.

getDateAdded

public java.util.Date getDateAdded()
Returns:
Returns the dateAdded.

setDateAdded

public void setDateAdded(java.util.Date dateAdded)
Parameters:
dateAdded - The dateAdded to set.

getDateAvailable

public java.util.Date getDateAvailable()
Returns:
Returns the dateAvailable.

setDateAvailable

public void setDateAvailable(java.util.Date dateAvailable)
Parameters:
dateAvailable - The dateAvailable to set.

getManufacturer

public AdminManufacturer getManufacturer()
Returns:
Returns the manufacturer.

setManufacturer

public void setManufacturer(AdminManufacturer manufacturer)
Parameters:
manufacturer - The manufacturer to set.

getManufacturerId

public int getManufacturerId()
Returns:
Returns the manufacturerId.

setManufacturerId

public void setManufacturerId(int manufacturerId)
Parameters:
manufacturerId - The manufacturerId to set.

getCategoryId

public int getCategoryId()
Returns:
Returns the categoryId.

setCategoryId

public void setCategoryId(int categoryId)
Parameters:
categoryId - The categoryId to set.

getOrdered

public int getOrdered()
Returns:
Returns the ordered.

setOrdered

public void setOrdered(int ordered)
Parameters:
ordered - The ordered to set.

getPriceExTax

public java.math.BigDecimal getPriceExTax()
Returns:
Returns the priceExTax.

setPriceExTax

public void setPriceExTax(java.math.BigDecimal priceExTax)
Parameters:
priceExTax - The priceExTax to set.

getSpecialPriceExTax

public java.math.BigDecimal getSpecialPriceExTax()
Returns:
Returns the specialPriceExTax.

setSpecialPriceExTax

public void setSpecialPriceExTax(java.math.BigDecimal specialPriceExTax)
Parameters:
specialPriceExTax - The specialPriceExTax to set.

getSpecialPriceIncTax

public java.math.BigDecimal getSpecialPriceIncTax()
Returns:
Returns the specialPriceIncTax.

setSpecialPriceIncTax

public void setSpecialPriceIncTax(java.math.BigDecimal specialPriceIncTax)
Parameters:
specialPriceIncTax - The specialPriceIncTax to set.

getPriceIncTax

public java.math.BigDecimal getPriceIncTax()
Returns:
Returns the priceIncTax.

setPriceIncTax

public void setPriceIncTax(java.math.BigDecimal priceIncTax)
Parameters:
priceIncTax - The priceIncTax to set.

getDescriptions

public AdminProductDescription[] getDescriptions()
Returns:
Returns the descriptions.

setDescriptions

public void setDescriptions(AdminProductDescription[] descriptions)
Parameters:
descriptions - The descriptions to set.

getFormattedPriceExTax

public java.lang.String getFormattedPriceExTax()
Returns:
Returns the formattedPriceExTax.

setFormattedPriceExTax

public void setFormattedPriceExTax(java.lang.String formattedPriceExTax)
Parameters:
formattedPriceExTax - The formattedPriceExTax to set.

getFormattedPriceIncTax

public java.lang.String getFormattedPriceIncTax()
Returns:
Returns the formattedPriceIncTax.

setFormattedPriceIncTax

public void setFormattedPriceIncTax(java.lang.String formattedPriceIncTax)
Parameters:
formattedPriceIncTax - The formattedPriceIncTax to set.

getFormattedSpecialPriceExTax

public java.lang.String getFormattedSpecialPriceExTax()
Returns:
Returns the formattedSpecialPriceExTax.

setFormattedSpecialPriceExTax

public void setFormattedSpecialPriceExTax(java.lang.String formattedSpecialPriceExTax)
Parameters:
formattedSpecialPriceExTax - The formattedSpecialPriceExTax to set.

getFormattedSpecialPriceIncTax

public java.lang.String getFormattedSpecialPriceIncTax()
Returns:
Returns the formattedSpecialPriceIncTax.

setFormattedSpecialPriceIncTax

public void setFormattedSpecialPriceIncTax(java.lang.String formattedSpecialPriceIncTax)
Parameters:
formattedSpecialPriceIncTax - The formattedSpecialPriceIncTax to set.

getSpecialExpiryDate

public java.util.Date getSpecialExpiryDate()
Returns:
Returns the specialExpiryDate.

setSpecialExpiryDate

public void setSpecialExpiryDate(java.util.Date specialExpiryDate)
Parameters:
specialExpiryDate - The specialExpiryDate to set.

getSpecialStatus

public byte getSpecialStatus()
Returns:
Returns the specialStatus.

setSpecialStatus

public void setSpecialStatus(byte specialStatus)
Parameters:
specialStatus - The specialStatus to set.

getCategories

public AdminCategory[] getCategories()
Returns:
Returns the categories.

setCategories

public void setCategories(AdminCategory[] categories)
Parameters:
categories - The categories to set.

getAttributes

public AdminProductAttribute[] getAttributes()
Returns:
Returns the attributes.

setAttributes

public void setAttributes(AdminProductAttribute[] attributes)
Parameters:
attributes - The attributes to set.

getSpecialId

public int getSpecialId()
Returns:
Returns the specialId.

setSpecialId

public void setSpecialId(int specialId)
Parameters:
specialId - The specialId to set.

getCustom1

public java.lang.String getCustom1()
Returns:
Returns the custom1.

setCustom1

public void setCustom1(java.lang.String custom1)
Parameters:
custom1 - The custom1 to set.

getCustom2

public java.lang.String getCustom2()
Returns:
Returns the custom2.

setCustom2

public void setCustom2(java.lang.String custom2)
Parameters:
custom2 - The custom2 to set.

getCustom3

public java.lang.String getCustom3()
Returns:
Returns the custom3.

setCustom3

public void setCustom3(java.lang.String custom3)
Parameters:
custom3 - The custom3 to set.

getCustom4

public java.lang.String getCustom4()
Returns:
Returns the custom4.

setCustom4

public void setCustom4(java.lang.String custom4)
Parameters:
custom4 - The custom4 to set.

getCustom5

public java.lang.String getCustom5()
Returns:
Returns the custom5.

setCustom5

public void setCustom5(java.lang.String custom5)
Parameters:
custom5 - The custom5 to set.

getProductQuantities

public AdminProductQuantity[] getProductQuantities()
Returns:
Returns the productQuantities.

setProductQuantities

public void setProductQuantities(AdminProductQuantity[] productQuantities)
Parameters:
productQuantities - The productQuantities to set.

getInvisible

public byte getInvisible()
Returns:
Returns the invisible.

setInvisible

public void setInvisible(byte invisible)
Parameters:
invisible - The invisible to set.

getSku

public java.lang.String getSku()
Returns:
Returns the sku.

setSku

public void setSku(java.lang.String sku)
Parameters:
sku - The sku to set.

getContentType

public java.lang.String getContentType()
Returns:
Returns the contentType.

setContentType

public void setContentType(java.lang.String contentType)
Parameters:
contentType - The contentType to set.

getFilePath

public java.lang.String getFilePath()
Returns:
Returns the filePath.

setFilePath

public void setFilePath(java.lang.String filePath)
Parameters:
filePath - The filePath to set.

getType

public int getType()
Returns:
Returns the type.

setType

public void setType(int type)
Parameters:
type - The type to set.

getImage2

public java.lang.String getImage2()
Returns:
Returns the image2.

setImage2

public void setImage2(java.lang.String image2)
Parameters:
image2 - The image2 to set.

getImage3

public java.lang.String getImage3()
Returns:
Returns the image3.

setImage3

public void setImage3(java.lang.String image3)
Parameters:
image3 - The image3 to set.

getImage4

public java.lang.String getImage4()
Returns:
Returns the image4.

setImage4

public void setImage4(java.lang.String image4)
Parameters:
image4 - The image4 to set.

getComparison

public java.lang.String getComparison()
Returns:
Returns the comparison.

setComparison

public void setComparison(java.lang.String comparison)
Parameters:
comparison - The comparison to set.

getPrice0

public java.math.BigDecimal getPrice0()
Returns:
Returns the price0.

setPrice0

public void setPrice0(java.math.BigDecimal price0)
Parameters:
price0 - The price0 to set.

getPrice1

public java.math.BigDecimal getPrice1()
Returns:
Returns the price1.

setPrice1

public void setPrice1(java.math.BigDecimal price1)
Parameters:
price1 - The price1 to set.

getPrice2

public java.math.BigDecimal getPrice2()
Returns:
Returns the price2.

setPrice2

public void setPrice2(java.math.BigDecimal price2)
Parameters:
price2 - The price2 to set.

getPrice3

public java.math.BigDecimal getPrice3()
Returns:
Returns the price3.

setPrice3

public void setPrice3(java.math.BigDecimal price3)
Parameters:
price3 - The price3 to set.

getEncodedOptionValues

public java.lang.String getEncodedOptionValues()
Returns:
Returns the encodedOptionValues.

setEncodedOptionValues

public void setEncodedOptionValues(java.lang.String encodedOptionValues)
Parameters:
encodedOptionValues - The encodedOptionValues to set.

getBundledProdQuantity

public int getBundledProdQuantity()
The number of times that this product appears in the bundle

Returns:
Returns the bundledProdQuantity.

setBundledProdQuantity

public void setBundledProdQuantity(int bundledProdQuantity)
The number of times that this product appears in the bundle

Parameters:
bundledProdQuantity - The bundledProdQuantity to set.

getDateLastModified

public java.util.Date getDateLastModified()
Returns:
the dateLastModified

setDateLastModified

public void setDateLastModified(java.util.Date dateLastModified)
Parameters:
dateLastModified - the dateLastModified to set

getMaxNumDownloads

public int getMaxNumDownloads()
Maximum number of downloads in the case of digital download products. Defaults to -1 in order to pick up the value in the DD_MAX_DOWNLOADS config variable.

Returns:
the maxNumDownloads

setMaxNumDownloads

public void setMaxNumDownloads(int maxNumDownloads)
Maximum number of downloads in the case of digital download products. Defaults to -1 in order to pick up the value in the DD_MAX_DOWNLOADS config variable.

Parameters:
maxNumDownloads - the maxNumDownloads to set

getMaxDownloadDays

public int getMaxDownloadDays()
Maximum number of days a product can be downloaded in the case of digital downloads. Defaults to -1 in order to pick up the value in the DD_MAX_DOWNLOAD_DAYS config variable.

Returns:
the maxDownloadDays

setMaxDownloadDays

public void setMaxDownloadDays(int maxDownloadDays)
Maximum number of days a product can be downloaded in the case of digital downloads. Defaults to -1 in order to pick up the value in the DD_MAX_DOWNLOAD_DAYS config variable.

Parameters:
maxDownloadDays - the maxDownloadDays to set

getStockReorderLevel

public int getStockReorderLevel()
Product needs to be reordered when the stock hits this level. Defaults to -1 in order to pick up the value in the STOCK_REORDER_LEVEL config variable.

Returns:
the stockReorderLevel

setStockReorderLevel

public void setStockReorderLevel(int stockReorderLevel)
Product needs to be reordered when the stock hits this level. Defaults to -1 in order to pick up the value in the STOCK_REORDER_LEVEL config variable.

Parameters:
stockReorderLevel - the stockReorderLevel to set

getCanOrderWhenNotInStock

public java.lang.Boolean getCanOrderWhenNotInStock()
Returns:
the canOrderWhenNotInStock

setCanOrderWhenNotInStock

public void setCanOrderWhenNotInStock(java.lang.Boolean canOrderWhenNotInStock)
Parameters:
canOrderWhenNotInStock - the canOrderWhenNotInStock to set

getPriceId

public int getPriceId()
Returns:
the priceId

setPriceId

public void setPriceId(int priceId)
Parameters:
priceId - the priceId to set

isIndexAttachment

public boolean isIndexAttachment()
Returns:
the indexAttachment

setIndexAttachment

public void setIndexAttachment(boolean indexAttachment)
Parameters:
indexAttachment - the indexAttachment to set

getRating

public java.math.BigDecimal getRating()
Returns:
the rating

setRating

public void setRating(java.math.BigDecimal rating)
Parameters:
rating - the rating to set

getExpiryDate

public java.util.Date getExpiryDate()
Returns:
the expiryDate

setExpiryDate

public void setExpiryDate(java.util.Date expiryDate)
Parameters:
expiryDate - the expiryDate to set

getCustom6

public java.lang.String getCustom6()
Returns:
the custom6

setCustom6

public void setCustom6(java.lang.String custom6)
Parameters:
custom6 - the custom6 to set

getCustom7

public java.lang.String getCustom7()
Returns:
the custom7

setCustom7

public void setCustom7(java.lang.String custom7)
Parameters:
custom7 - the custom7 to set

getCustom8

public java.lang.String getCustom8()
Returns:
the custom8

setCustom8

public void setCustom8(java.lang.String custom8)
Parameters:
custom8 - the custom8 to set

getCustom9

public java.lang.String getCustom9()
Returns:
the custom9

setCustom9

public void setCustom9(java.lang.String custom9)
Parameters:
custom9 - the custom9 to set

getCustom10

public java.lang.String getCustom10()
Returns:
the custom10

setCustom10

public void setCustom10(java.lang.String custom10)
Parameters:
custom10 - the custom10 to set

getCustom1Int

public int getCustom1Int()
Returns:
the custom1Int

setCustom1Int

public void setCustom1Int(int custom1Int)
Parameters:
custom1Int - the custom1Int to set

getCustom2Int

public int getCustom2Int()
Returns:
the custom2Int

setCustom2Int

public void setCustom2Int(int custom2Int)
Parameters:
custom2Int - the custom2Int to set

getCustom1Dec

public java.math.BigDecimal getCustom1Dec()
Returns:
the custom1Dec

setCustom1Dec

public void setCustom1Dec(java.math.BigDecimal custom1Dec)
Parameters:
custom1Dec - the custom1Dec to set

getCustom2Dec

public java.math.BigDecimal getCustom2Dec()
Returns:
the custom2Dec

setCustom2Dec

public void setCustom2Dec(java.math.BigDecimal custom2Dec)
Parameters:
custom2Dec - the custom2Dec to set

getPaymentScheduleId

public int getPaymentScheduleId()
Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.

Returns:
the paymentScheduleId

setPaymentScheduleId

public void setPaymentScheduleId(int paymentScheduleId)
Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.

Parameters:
paymentScheduleId - the paymentScheduleId to set

getPaymentSchedule

public AdminPaymentSchedule getPaymentSchedule()
A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.

Returns:
the paymentSchedule

setPaymentSchedule

public void setPaymentSchedule(AdminPaymentSchedule paymentSchedule)
A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.

Parameters:
paymentSchedule - the paymentSchedule to set

getSpecialStartDate

public java.util.Date getSpecialStartDate()
Returns:
the specialStartDate

setSpecialStartDate

public void setSpecialStartDate(java.util.Date specialStartDate)
Parameters:
specialStartDate - the specialStartDate to set

getTierPrices

public AdminTierPrice[] getTierPrices()
Returns:
the tierPrices

setTierPrices

public void setTierPrices(AdminTierPrice[] tierPrices)
Parameters:
tierPrices - the tierPrices to set

getTemplateId

public int getTemplateId()
Returns:
the templateId

setTemplateId

public void setTemplateId(int templateId)
Parameters:
templateId - the templateId to set

getTemplateName

public java.lang.String getTemplateName()
Returns:
the templateName

setTemplateName

public void setTemplateName(java.lang.String templateName)
Parameters:
templateName - the templateName to set

getCustomAttrs

public java.lang.String getCustomAttrs()
Contains the custom attributes in XML format

Returns:
the customAttrs

setCustomAttrs

public void setCustomAttrs(java.lang.String customAttrs)
Contains the custom attributes in XML format

Parameters:
customAttrs - the customAttrs to set

getCustomAttrArray

public AdminProdAttrDesc[] getCustomAttrArray()
An array of AdminProdAttrDesc objects

Returns:
the customAttrArray

setCustomAttrArray

public void setCustomAttrArray(AdminProdAttrDesc[] customAttrArray)
An array of AdminProdAttrDesc objects

Parameters:
customAttrArray - the customAttrArray to set

getStoreCustom1

public java.lang.String getStoreCustom1()
Custom field with unique value for a store when in multi-store shared products mode

Returns:
the storeCustom1

setStoreCustom1

public void setStoreCustom1(java.lang.String storeCustom1)
Custom field with unique value for a store when in multi-store shared products mode

Parameters:
storeCustom1 - the storeCustom1 to set

getStoreCustom2

public java.lang.String getStoreCustom2()
Custom field with unique value for a store when in multi-store shared products mode

Returns:
the storeCustom2

setStoreCustom2

public void setStoreCustom2(java.lang.String storeCustom2)
Custom field with unique value for a store when in multi-store shared products mode

Parameters:
storeCustom2 - the storeCustom2 to set

getStoreCustom3

public java.lang.String getStoreCustom3()
Custom field with unique value for a store when in multi-store shared products mode

Returns:
the storeCustom3

setStoreCustom3

public void setStoreCustom3(java.lang.String storeCustom3)
Custom field with unique value for a store when in multi-store shared products mode

Parameters:
storeCustom3 - the storeCustom3 to set

getBookableProd

public AdminBookableProduct getBookableProd()
Returns:
the bookableProd

setBookableProd

public void setBookableProd(AdminBookableProduct bookableProd)
Parameters:
bookableProd - the bookableProd to set

getExtQuantity

public java.lang.Integer getExtQuantity()
Returns:
the extQuantity

setExtQuantity

public void setExtQuantity(java.lang.Integer extQuantity)
Parameters:
extQuantity - the extQuantity to set

getExtPrice0

public java.math.BigDecimal getExtPrice0()
Returns:
the extPrice0

setExtPrice0

public void setExtPrice0(java.math.BigDecimal extPrice0)
Parameters:
extPrice0 - the extPrice0 to set

getExtPrice1

public java.math.BigDecimal getExtPrice1()
Returns:
the extPrice1

setExtPrice1

public void setExtPrice1(java.math.BigDecimal extPrice1)
Parameters:
extPrice1 - the extPrice1 to set

getExtPrice2

public java.math.BigDecimal getExtPrice2()
Returns:
the extPrice2

setExtPrice2

public void setExtPrice2(java.math.BigDecimal extPrice2)
Parameters:
extPrice2 - the extPrice2 to set

getExtPrice3

public java.math.BigDecimal getExtPrice3()
Returns:
the extPrice3

setExtPrice3

public void setExtPrice3(java.math.BigDecimal extPrice3)
Parameters:
extPrice3 - the extPrice3 to set

getMiscItems

public AdminMiscItem[] getMiscItems()
Returns the array of Miscellaneous Items associated with this product.

Returns:
the miscItems associated with this product.

setMiscItems

public void setMiscItems(AdminMiscItem[] miscItems)
Parameters:
miscItems - the miscItems to set

getMasterProdDate

public java.util.Date getMasterProdDate()
When copies of the same product exist in different stores, this is the last modified date of the master product. It is used to determine whether a store has the latest version of the product data.

Returns:
the masterProdDate

setMasterProdDate

public void setMasterProdDate(java.util.Date masterProdDate)
When copies of the same product exist in different stores, this is the last modified date of the master product. It is used to determine whether a store has the latest version of the product data.

Parameters:
masterProdDate - the masterProdDate to set

getUuid

public java.lang.String getUuid()
A unique identifier to identify products that exist in different stores in different versions. Used when using stores to contain pre-production product data.

Returns:
the uuid

setUuid

public void setUuid(java.lang.String uuid)
A unique identifier to identify products that exist in different stores in different versions. Used when using stores to contain pre-production product data.

Parameters:
uuid - the uuid to set


Copyright © 2011 DS Data Systems UK Ltd.