public class ProductDataBean extends ProductAccessBean implements ProductSmartDataBean, ProductInputDataBean
You can find more information about data beans in the WebSphere Commerce data beans topic in the Information Center.
Access Beans: Product
Mandatory Parameters (for single row retrieval):
Some hints and tips for using this data bean are:
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COPYRIGHT
The internal copyright field.
|
emptyString| Constructor and Description |
|---|
ProductDataBean()
Constructs an empty
ProductDataBean object. |
ProductDataBean(CatalogEntryAccessBean abCatentry)
Constructs a
ProductDataBean from a CatalogEntryAccessBean. |
ProductDataBean(CatalogEntryAccessBean abCatEntry,
CommandContext aCommandContext)
Constructs a
ProductDataBean from a CatalogEntryAccessBean and a command context. |
ProductDataBean(ProductAccessBean abProduct,
CommandContext aCommandContext)
Constructs a
ProductDataBean from a CatalogEntryAccessBean and a command context. |
| Modifier and Type | Method and Description |
|---|---|
AttachmentDataBean[] |
getAllAttachments()
Gets all the attachments in the product.
|
java.lang.Long[] |
getApplicableContractIds()
Gets a list of applicable contract IDs for calculating the prices.
|
com.ibm.commerce.catalog.util.RangePricingData[] |
getApplicableContractPriceRanges()
Retrieve the tiered pricing information for the current product in all the applicable contracts.
|
PriceDataBean[] |
getApplicableContractPrices()
Gets a list of the applicable contracts' prices for calculating the prices.
|
AttachmentDataBean[] |
getAttachmentsByUsage()
Get all the product attachments by the specified attachment relation usage.
|
AttachmentUsageDataBean[] |
getAttachmentUsages()
Gets all the attachment relation usage used in the product attachments
If there are no attachment usages to return, this method will return a zero length array.
|
AttributeDataBean[] |
getAttributeDataBeans()
Gets a list of data beans that represent attributes of the product.
|
AttributeAccessBean[] |
getAttributes()
Gets a list of beans that represent attributes of the product.
|
RelatedBundleDataBean[] |
getBundleAccessories()
Gets a list of beans that represent bundles that are accessories to this product.
|
RelatedBundleDataBean[] |
getBundleAssociations()
Gets a list of beans that represent bundles that are merchandising associations for this product.
|
RelatedBundleDataBean[] |
getBundleCrossSells()
Gets a list of beans that represent bundles that are cross-sells to this product.
|
RelatedBundleDataBean[] |
getBundleUpSells()
Gets a list of beans that represent bundles that are up-sells to this product.
|
PriceDataBean |
getCalculatedContractPrice()
Gets a
PriceDataBean object that represents the calculated contract price for the product. |
PriceDataBean |
getCalculatedPrice()
Gets a
PriceDataBean object that represents the calculated price for the product. |
CommandContext |
getCommandContext()
Gets the current command's context passed in at run time.
|
AttributeDataBean[] |
getDefiningAttributeDataBeans()
Gets a list of data beans that represent defining attributes of the product.
|
AttributeAccessBean[] |
getDefiningAttributes()
Gets a list of beans that represent defining attributes of the product.
|
CatalogEntryDescriptionAccessBean |
getDescription()
Gets a bean representing descriptive information about this product.
|
AttributeDataBean[] |
getDescriptiveAttributeDataBeans()
Gets a list of data beans that represent descriptive attributes of the product.
|
AttributeAccessBean[] |
getDescriptiveAttributes()
Gets a list of beans that represent descriptive attributes of the product.
|
CategorizedMonetaryAmountsDataBean |
getDisplayTaxes()
Invokes the
getTaxes method in PriceDataBean to calculate the taxes for those
tax categories that are displayable at product display time. |
RelatedDynamicKitDataBean[] |
getDynamicKitAccessories()
Gets a list of beans that represent dynamic kits that are accessories.
|
RelatedDynamicKitDataBean[] |
getDynamicKitAssociations()
Gets a list of beans that represent dynamic kits that are merchandising associations for this product.
|
RelatedDynamicKitDataBean[] |
getDynamicKitCrossSells()
Gets a list of beans that represent dynamic kits that are cross-sells.
|
RelatedDynamicKitDataBean[] |
getDynamicKitUpSells()
Gets a list of beans that represent dynamic kits that are up-sells.
|
ItemDataBean[] |
getEntitledItems()
Gets a list of beans that represent items that are entitled to be seen by the user who is browsing this product.
|
boolean |
getErrorMode()
Gets the error mode.
|
RelatedItemDataBean[] |
getItemAccessories()
Gets a list of beans that represent items that are accessories to this product.
|
RelatedItemDataBean[] |
getItemAssociations()
Gets a list of beans that represent items that are merchandising associations for this product.
|
RelatedItemDataBean[] |
getItemCrossSells()
Gets a list of beans that represent items that are cross-sells to this product.
|
ItemDataBean[] |
getItemDataBeans()
Gets a list of item data beans that represent the items of the product.
|
RelatedItemDataBean[] |
getItemUpSells()
Gets a list of beans that represent items that are up-sells to this product.
|
PriceDataBean |
getListPrice()
Gets a bean that represents the list price for the product.
|
PriceDataBean |
getMaximumItemPrice()
Gets the maximum item price amongst all items for the product.
|
PriceDataBean |
getMinimumItemPrice()
Gets the minimum item price amongst all items for the product.
|
int |
getNumberOfApplicableContractIds()
Gets the number of applicable contract IDs for calculating the prices.
|
java.lang.String |
getObjectPath()
Gets the path to objects such as images in the context of the current store.
|
RelatedPackageDataBean[] |
getPackageAccessories()
Gets a list of beans that represent packages that are accessories to this product.
|
RelatedPackageDataBean[] |
getPackageAssociations()
Gets a list of beans that represent packages that are merchandising associations for this product.
|
RelatedPackageDataBean[] |
getPackageCrossSells()
Gets a list of beans that represent packages that are cross-sells to this product.
|
RelatedPackageDataBean[] |
getPackageUpSells()
Gets a list of beans that represent packages that are up-sells to this product.
|
java.lang.String |
getPartNumber()
Gets the part (SKU) number of the product.
|
RelatedProductDataBean[] |
getProductAccessories()
Gets a list of beans that represent products that are accessories to this product.
|
RelatedProductDataBean[] |
getProductAssociations()
Gets a list of beans that represent products that are merchandising associations for this product.
|
RelatedProductDataBean[] |
getProductCrossSells()
Gets a list of beans that represent products that are cross-sells to this product.
|
java.lang.String |
getProductID()
Gets the product ID that represents the primary key for this product.
|
RelatedProductDataBean[] |
getProductReplacements()
Gets a list of beans that represent products that are replacements to this product.
|
RelatedProductDataBean[] |
getProductUpSells()
Gets a list of beans that represent products that are up-sells to this product.
|
ItemDataBean[] |
getPublishedItems()
Gets a list of beans that represent the items for this product.
|
TypedProperty |
getRequestProperties()
Gets the request property.
|
PriceDataBean |
getStandardPrice()
Gets a PriceDataBean that represents the standard contract price for the product.
|
boolean |
isAdminMode()
Gets the administrative mode of the bean.
|
boolean |
isAnyMerchandisingAssociated()
Determines whether there are any OOB or custom merchandising associations associated with this catalog entry
|
boolean |
isCalculatedContractPriced()
Determines whether the product has a calculated contract price.
|
boolean |
isCheckNumberOfApplicableContractIds()
Determines whether the item has any applicable contract IDs
|
boolean |
isEnableAttributeLanguageFallback()
Returns
true if language fallback on attribute name is
enabled, false otherwise. |
boolean |
isListPriced()
Determines whether the product has a list price.
|
boolean |
isMerchandisingAssociated()
Determines whether there are any merchandising associations associated with this product
|
void |
populate()
Loads data into the data bean when the
DataBeanManager.activate() runs. |
void |
setAdminMode(boolean aboolAdminMode)
Sets the administrative mode of the bean.
|
void |
setAssociationType(java.lang.String type)
Sets the variable
istrAssociationType, which represents the target association type to be processed by
an internal method called processCatalogEntryAssociation(). |
void |
setAttachmentUsage(java.lang.String astrAttachmentUsage)
Sets the attachment relation usage identifier to get all the attachments of the product with the same usage.
|
void |
setCommandContext(CommandContext aCommandContext)
Sets the command context passed in at run time.
|
void |
setDescription(CatalogEntryDescriptionAccessBean aabDescription)
Sets the descriptive information object about this product.
|
void |
setEnableAttributeLanguageFallback(boolean enableAttributeLanguageFallback)
Enables the language fallback for retrieving the attribute names.
|
void |
setErrorMode(boolean aErrorMode)
Sets the error mode.
|
void |
setPartNumber(java.lang.String astrProductPartNumber)
Sets the product part (SKU) number.
|
void |
setProductID(java.lang.String astrProductId)
Sets the product ID that represents the primary key for this product.
|
void |
setRequestProperties(TypedProperty aParam)
Sets the request properties and populates the parameters that are needed by the bean.
|
findByBaseItemId, findByBaseItemIdAndStore, findByBaseItemIdAndStoreNoCache, findByBaseItemIdNoCache, findByItem, findByItemNoCache, findSkuByAttributes, fulfills, getAttributes, getAvailabilityDate, getBaseItem, getBaseItemId, getBaseItemIdInEntityType, getBuyable, getBuyableInEntityType, getCatalogEntriesAccessory, getCatalogEntriesAccessory, getCatalogEntriesAccessory, getCatalogEntriesAccessory, getCatalogEntriesAccessoryByStore, getCatalogEntriesAccessoryByStore, getCatalogEntriesAccessoryByStore, getCatalogEntriesAccessoryByStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesCrossell, getCatalogEntriesCrossell, getCatalogEntriesCrossell, getCatalogEntriesCrossell, getCatalogEntriesCrossellByStore, getCatalogEntriesCrossellByStore, getCatalogEntriesCrossellByStore, getCatalogEntriesCrossellByStore, getCatalogEntriesUpSell, getCatalogEntriesUpSell, getCatalogEntriesUpSell, getCatalogEntriesUpSell, getCatalogEntriesUpSellByStore, getCatalogEntriesUpSellByStore, getCatalogEntriesUpSellByStore, getCatalogEntriesUpSellByStore, getCatalogEntryReferenceNumber, getCatalogEntryReferenceNumberInEntityType, getChildCatalogEntries, getDescription, getDescription, getDescriptionNoCache, getDiscontinueDate, getEndDate, getEndOfServiceDate, getEntitledChildCatalogEntries, getEntitledItems, getEntitledItems, getEntity, getField1, getField1InEntityType, getField2, getField2InEntityType, getField3, getField3InEntityType, getField4, getField5, getItems, getItemspc_id, getItemspc_idInEntityType, getLanguage_id, getLanguage_idInEntityType, getLastOrderDate, getLastUpdate, getLastUpdateInEntityType, getListPrice, getManufacturerName, getManufacturerPartNumber, getMarkForDelete, getMarkForDeleteInEntityType, getMemberId, getMemberIdInEntityType, getOid, getOnAuction, getOnAuctionInEntityType, getOnSpecial, getOnSpecialInEntityType, getOwner, getParentCatalogEntryIds, getStartDate, getState, getTemplateFileName, getTemplateFileName, getTemplateFileName, getTemplateFileName, getType, getUrl, instantiateEntity, isCatalogEntryInStore, setAvailabilityDate, setBaseItemId, setBaseItemId, setBuyable, setBuyable, setDiscontinueDate, setEndDate, setEndOfServiceDate, setField1, setField1, setField2, setField2, setField3, setField3, setField4, setField5, setInitKey_catalogEntryReferenceNumber, setInitKey_catalogEntryReferenceNumber, setItemspc_id, setItemspc_id, setLanguage_id, setLanguage_id, setLastOrderDate, setLastUpdate, setLastUpdate, setManufacturerName, setManufacturerPartNumber, setMarkForDelete, setMarkForDelete, setMemberId, setMemberId, setOid, setOnAuction, setOnAuction, setOnSpecial, setOnSpecial, setStartDate, setState, setUrlpublic static final java.lang.String COPYRIGHT
public ProductDataBean()
ProductDataBean object.public ProductDataBean(CatalogEntryAccessBean abCatentry)
ProductDataBean from a CatalogEntryAccessBean.abCatentry - The CatalogEntryAccessBean.public ProductDataBean(CatalogEntryAccessBean abCatEntry, CommandContext aCommandContext)
ProductDataBean from a CatalogEntryAccessBean and a command context.abCatEntry - The CatalogEntryAccessBean.aCommandContext - The command context as CommandContext object.public ProductDataBean(ProductAccessBean abProduct, CommandContext aCommandContext)
ProductDataBean from a CatalogEntryAccessBean and a command context.abProduct - The ProductAccessBean.aCommandContext - The command context as CommandContext object.public java.lang.Long[] getApplicableContractIds()
throws ECException
getApplicableContractIds in interface ProductSmartDataBeanECException - An exception occurs during the execution of the method.public PriceDataBean[] getApplicableContractPrices()
getApplicableContractPrices in interface ProductSmartDataBeanPriceDatabean.ECException - An exception occurs during the execution of the method.public AttachmentDataBean[] getAllAttachments()
AttachmentDataBeanpublic AttachmentDataBean[] getAttachmentsByUsage()
AttachmentDataBeanpublic AttachmentUsageDataBean[] getAttachmentUsages()
AttachmentUsageDataBeanpublic AttributeAccessBean[] getAttributes()
getAttributes in interface ProductSmartDataBeangetAttributes in class ProductAccessBeanAttributeAccessBean.public AttributeAccessBean[] getDefiningAttributes()
AttributeAccessBean.public AttributeAccessBean[] getDescriptiveAttributes()
AttributeAccessBean.public RelatedBundleDataBean[] getBundleAccessories() throws ECException
getBundleAccessories in interface ProductSmartDataBeanRelatedBundleDataBean.ECException - An exception occurs during the execution of the method.public RelatedBundleDataBean[] getBundleAssociations() throws ECException
istrAssociationType. Set the variable istrAssociationType through the
setAssociationType() method before calling getBundleAssociations. If
istrAssociationType is null, all types of merchandising associations will return.
For example, the following code returns a list of beans that are bundle up-sells for this product:
setAssociationType("UPSELL");
RelatedBundleDataBean[] rb = getBundleAssociations();
RelatedBundleDataBean.ECException - An exception occurs during the execution of the method.public RelatedBundleDataBean[] getBundleCrossSells() throws ECException
getBundleCrossSells in interface ProductSmartDataBeanRelatedBundleDataBean.ECException - An exception occurs during the execution of the method.public RelatedBundleDataBean[] getBundleUpSells() throws ECException
getBundleUpSells in interface ProductSmartDataBeanRelatedBundleDataBean.ECException - An exception occurs during the execution of the method.public PriceDataBean getCalculatedContractPrice() throws ECException
PriceDataBean object that represents the calculated contract price for the product.getCalculatedContractPrice in interface ProductSmartDataBeanPriceDataBean.ECException - An exception occurs during the execution of the method.public PriceDataBean getCalculatedPrice() throws ECException
PriceDataBean object that represents the calculated price for the product.getCalculatedPrice in interface ProductSmartDataBeanPriceDataBean.ECException - An exception occurs during the execution of the method.public CommandContext getCommandContext()
getCommandContext in interface SmartDataBeanCommandContext object.public CatalogEntryDescriptionAccessBean getDescription()
getDescription in interface ProductSmartDataBeangetDescription in class ProductAccessBeanCatalogEntryDescriptionAccessBean.public CategorizedMonetaryAmountsDataBean getDisplayTaxes() throws ECException
getTaxes method in PriceDataBean to calculate the taxes for those
tax categories that are displayable at product display time.getDisplayTaxes in interface ProductSmartDataBeanCategorizedMonetaryAmountsDataBean containing the
taxing monetary amounts, names and descriptions.ECException - An exception occurs during the execution of the method.public ItemDataBean[] getEntitledItems() throws ECException
ItemDataBean.ECException - An exception occurs during the execution of the method.public boolean getErrorMode()
true if the error mode is set; false otherwise.public RelatedDynamicKitDataBean[] getDynamicKitAccessories() throws ECException
RelatedDynamicKitDataBean.ECException - An exception occurs during the execution of the method.public RelatedDynamicKitDataBean[] getDynamicKitAssociations() throws ECException
istrAssociationType. Set the variable istrAssociationType through the
setAssociationType() method before calling getDynamicKitAssociations. If
istrAssociationType is null, all types of merchandising associations will return.
For example, the following code returns a list of beans that are dynamic kit up-sells for this product:
setAssociationType("UPSELL");
RelatedDynamicKitDataBean[] rb = getDynamicKitAssociations();
RelatedDynamicKitDataBean.ECException - An exception occurs during the execution of the method.public RelatedDynamicKitDataBean[] getDynamicKitCrossSells() throws ECException
RelatedDynamicKitDataBean.ECException - An exception occurs during the execution of the method.public RelatedDynamicKitDataBean[] getDynamicKitUpSells() throws ECException
RelatedDynamicKitDataBean.ECException - An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemAccessories() throws ECException
getItemAccessories in interface ProductSmartDataBeanRelatedItemDataBean.ECException - An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemAssociations() throws ECException
istrAssociationType. Set the variable istrAssociationType through the
setAssociationType() method before calling getItemAssociations. If
istrAssociationType is null, all types of merchandising associations will return.
For example, the following code returns a list of beans that are item up-sells for this product:
setAssociationType("UPSELL");
RelatedItemDataBean[] ri = getItemAssociations();
RelatedItemDataBean.ECException - An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemCrossSells() throws ECException
getItemCrossSells in interface ProductSmartDataBeanRelatedItemDataBean.ECException - An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemUpSells() throws ECException
getItemUpSells in interface ProductSmartDataBeanRelatedItemDataBean.ECException - An exception occurs during the execution of the method.public PriceDataBean getListPrice() throws ECException
getListPrice in interface ProductSmartDataBeanPriceDataBean.ECExceptionpublic java.lang.String getObjectPath()
throws ECException
ECException - An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageAssociations() throws ECException
istrAssociationType. Set the variable istrAssociationType through the
setAssociationType() method before calling getPackageAssociations. If
istrAssociationType is null, all types of merchandising associations will return.
For example, the following code returns a list of beans that are package up-sells for this product:
setAssociationType("UPSELL");
RelatedPackageDataBean[] rp = getPackageAssociations();
RelatedPackageDataBean.ECException - An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageAccessories() throws ECException
getPackageAccessories in interface ProductSmartDataBeanRelatedPackageDataBean.ECException - An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageCrossSells() throws ECException
getPackageCrossSells in interface ProductSmartDataBeanRelatedPackageDataBean.ECException - An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageUpSells() throws ECException
getPackageUpSells in interface ProductSmartDataBeanRelatedPackageDataBean.ECException - An exception occurs during the execution of the method.public java.lang.String getPartNumber()
getPartNumber in interface ProductSmartDataBeangetPartNumber in class ProductAccessBeanpublic RelatedProductDataBean[] getProductAccessories() throws ECException
getProductAccessories in interface ProductSmartDataBeanRelatedProductDataBean.ECException - An exception occurs during the execution of the method.public RelatedProductDataBean[] getProductAssociations() throws ECException
istrAssociationType. Set the variable istrAssociationType through the
setAssociationType() method before calling getProductAssociations. If
istrAssociationType is null, all types of merchandising associations will return.
For example, the following code returns a list of beans that are product up-sells for this product:
setAssociationType("UPSELL");
RelatedProductDataBean[] rp = getProductAssociations();
RelatedProductDataBean.ECException - An exception occurs during the execution of the method.public RelatedProductDataBean[] getProductCrossSells() throws ECException
getProductCrossSells in interface ProductSmartDataBeanRelatedProductDataBean.ECException - An exception occurs during the execution of the method.public java.lang.String getProductID()
getProductID in interface ProductSmartDataBeanpublic RelatedProductDataBean[] getProductUpSells() throws ECException
getProductUpSells in interface ProductSmartDataBeanRelatedProductDataBean.ECException - An exception occurs during the execution of the method.public ItemDataBean[] getPublishedItems() throws ECException
ItemDataBean.ECException - An exception occurs during the execution of the method.public TypedProperty getRequestProperties()
getRequestProperties in interface InputDataBeanTypedProperty object.public void populate()
DataBeanManager.activate() runs.populate in interface SmartDataBeanjava.lang.Exception - An exception occurs during the execution of the method.public RelatedProductDataBean[] getProductReplacements() throws ECException
RelatedProductDatabean.ECException - An exception occurs during the execution of the method.public void setCommandContext(CommandContext aCommandContext)
setCommandContext in interface SmartDataBeanaCommandContext - The command context as CommandContext object.public void setDescription(CatalogEntryDescriptionAccessBean aabDescription)
aabDescription - The CatalogEntryDescriptionAccessBean.public void setErrorMode(boolean aErrorMode)
setErrorMode in interface ProductInputDataBeanaErrorMode - true to have the error mode sets; false otherwise.public void setPartNumber(java.lang.String astrProductPartNumber)
setPartNumber in interface ProductInputDataBeansetPartNumber in class ProductAccessBeanastrProductPartNumber - The part (SKU) number.public void setProductID(java.lang.String astrProductId)
setProductID in interface ProductInputDataBeanastrProductId - The product ID.public boolean isEnableAttributeLanguageFallback()
true if language fallback on attribute name is
enabled, false otherwise.public void setEnableAttributeLanguageFallback(boolean enableAttributeLanguageFallback)
trueenableAttributeLanguageFallback - The iEnableAttributeLanguageFallback to set. true
to enable the language fallback, false to
disable it.public void setRequestProperties(TypedProperty aParam)
setRequestProperties in interface InputDataBeanaParam - The request property as TypedProperty object.public boolean isAdminMode()
false is the default.true if the administrative mode is set; false otherwise.public void setAdminMode(boolean aboolAdminMode)
false is the default.aboolAdminMode - true to have the administrative mode sets; false otherwise.public void setAssociationType(java.lang.String type)
istrAssociationType, which represents the target association type to be processed by
an internal method called processCatalogEntryAssociation(). Call this method before the following methods to
retrieve a list of specific merchandising association types: getBundleAssociations,
getDynamicKitAssociations, getItemAssociations, getPackageAssociations,
getProductAssociations. If type is null, all types of merchandising associations will return.
type - The merchandising association type. Valid values are stored in the MASSOCTYPE.MASSOCTYPE_ID column, for example, "X-SELL".public PriceDataBean getStandardPrice()
PriceDataBean.public void setAttachmentUsage(java.lang.String astrAttachmentUsage)
astrAttachmentUsage - The attachment relation usage identifierpublic AttributeDataBean[] getDefiningAttributeDataBeans()
AttributeDataBean.public AttributeDataBean[] getAttributeDataBeans()
AttributeDataBean.public AttributeDataBean[] getDescriptiveAttributeDataBeans()
AttributeDataBean.public ItemDataBean[] getItemDataBeans()
ItemDataBean.public boolean isMerchandisingAssociated()
public boolean isAnyMerchandisingAssociated()
public PriceDataBean getMinimumItemPrice()
com.ibm.commerce.price.beans.PriceDataBean with the lowest item price.public PriceDataBean getMaximumItemPrice()
com.ibm.commerce.price.beans.PriceDataBean with the maximum item price.public boolean isCalculatedContractPriced()
public boolean isListPriced()
public int getNumberOfApplicableContractIds()
throws ECException
ECException - An exception occurs during the execution of the method. An exception occurs during the execution of the method.public boolean isCheckNumberOfApplicableContractIds()
public com.ibm.commerce.catalog.util.RangePricingData[] getApplicableContractPriceRanges()
throws ECException
RangePricingData that contains the tiered pricing data for
each of the contracts applicable to this product.ECException - An exception occurs during the execution of the method.