com.ibm.commerce.catalog.beans
Class ProductDataBean
java.lang.Object
com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
com.ibm.commerce.catalog.objects.ProductAccessBean
com.ibm.commerce.catalog.beans.ProductDataBean
- All Implemented Interfaces:
- DataBean, InputDataBean, ProductAccessBeanData, ProductInputDataBean, ProductSmartDataBean, java.io.Serializable, SmartDataBean
- public class ProductDataBean
- extends ProductAccessBean
- implements ProductSmartDataBean, ProductInputDataBean
This data bean represents a product.
- See Also:
- Serialized Form
Field Summary |
static java.lang.String |
COPYRIGHT
The internal copyright field. |
Methods inherited from class com.ibm.commerce.catalog.objects.ProductAccessBean |
commitCopyHelper, defaultJNDIName, findByBaseItemId, findByBaseItemIdAndStore, findByItem, findSkuByAttributes, fulfills, getAttributes, getBaseItem, getBaseItemId, getBaseItemIdInEJBType, getBuyable, getBuyableInEJBType, getCatalogEntriesAccessory, getCatalogEntriesAccessory, getCatalogEntriesAccessory, getCatalogEntriesAccessoryByStore, getCatalogEntriesAccessoryByStore, getCatalogEntriesAccessoryByStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesCrossell, getCatalogEntriesCrossell, getCatalogEntriesCrossell, getCatalogEntriesCrossellByStore, getCatalogEntriesCrossellByStore, getCatalogEntriesCrossellByStore, getCatalogEntriesUpSell, getCatalogEntriesUpSell, getCatalogEntriesUpSell, getCatalogEntriesUpSellByStore, getCatalogEntriesUpSellByStore, getCatalogEntriesUpSellByStore, getCatalogEntryReferenceNumber, getCatalogEntryReferenceNumberInEJBType, getDescription, getDescription, getEndDate, getEntitledItems, getField1, getField1InEJBType, getField2, getField2InEJBType, getField3, getField3InEJBType, getField4, getField5, getItems, getItemspc_id, getItemspc_idInEJBType, getLanguage_id, getLanguage_idInEJBType, getLastUpdate, getLastUpdateInEJBType, getListPrice, getManufacturerName, getManufacturerPartNumber, getMarkForDelete, getMarkForDeleteInEJBType, getMemberId, getMemberIdInEJBType, getOid, getOnAuction, getOnAuctionInEJBType, getOnSpecial, getOnSpecialInEJBType, getOwner, getParentCatalogEntryIds, getStartDate, getState, getTemplateFileName, getTemplateFileName, getTemplateFileName, getTemplateFileName, getType, getUrl, instantiateEJB, instantiateEJBByPrimaryKey, isCatalogEntryInStore, refreshCopyHelper, setBaseItemId, setBaseItemId, setBuyable, setBuyable, setEndDate, setField1, setField1, setField2, setField2, setField3, setField3, setField4, setField5, setInitKey_catalogEntryReferenceNumber, setItemspc_id, setItemspc_id, setLanguage_id, setLanguage_id, setLastUpdate, setLastUpdate, setManufacturerName, setManufacturerPartNumber, setMarkForDelete, setMarkForDelete, setMemberId, setMemberId, setOid, setOnAuction, setOnAuction, setOnSpecial, setOnSpecial, setStartDate, setState, setUrl |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- The internal copyright field.
- See Also:
- Constant Field Values
ProductDataBean
public ProductDataBean()
- Constructs an empty ProductDataBean object.
ProductDataBean
public ProductDataBean(CatalogEntryAccessBean abCatentry)
throws javax.ejb.CreateException,
java.rmi.RemoteException,
javax.ejb.FinderException,
javax.naming.NamingException
- Constructs a ProductDataBean from a CatalogEntryAccessBean.
- Parameters:
- abCatentry - The CatalogEntryAccessBean.
- Throws:
- CreateException - In the execution of the method, a create exception occurs.
- FinderException - In the execution of the method, a finder exception occurs.
- NamingException - In the execution of the method, a naming exception occurs.
- RemoteException - In the execution of the method, a remote exception occurs.
ProductDataBean
public ProductDataBean(CatalogEntryAccessBean abCatEntry,
CommandContext aCommandContext)
throws javax.ejb.CreateException,
java.rmi.RemoteException,
javax.ejb.FinderException,
javax.naming.NamingException
- Constructs a ProductDataBean from a CatalogEntryAccessBean and a command context.
- Parameters:
- abCatEntry - The CatalogEntryAccessBean.
- aCommandContext - The command context as CommandContext object.
- Throws:
- CreateException - In the execution of the method, a create exception occurs.
- FinderException - In the execution of the method, a finder exception occurs.
- NamingException - In the execution of the method, a naming exception occurs.
- RemoteException - In the execution of the method, a remote exception occurs.
getApplicableContractIds
public java.lang.Long[] getApplicableContractIds()
throws ECException
- Gets a list of applicable contract IDs for calculating the prices.
-
- Specified by:
- getApplicableContractIds in interface ProductSmartDataBean
-
- Returns:
- The list of contract IDs.
- Throws:
- ECException - An exception occurs during the execution of the method.
getApplicableContractPrices
public PriceDataBean[] getApplicableContractPrices()
throws ECException
- Gets a list of the applicable contracts' prices for calculating the prices.
-
- Specified by:
- getApplicableContractPrices in interface ProductSmartDataBean
-
- Returns:
- The list of PriceDatabean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getAttributes
public AttributeAccessBean[] getAttributes()
throws javax.ejb.FinderException,
javax.ejb.CreateException,
javax.naming.NamingException,
java.rmi.RemoteException
- Gets a list of beans that represent attributes of the product.
-
- Specified by:
- getAttributes in interface ProductSmartDataBean
- Overrides:
- getAttributes in class ProductAccessBean
-
- Returns:
- The list of AttributeAccessBean.
- Throws:
- CreateException - In the execution of the method, a create exception occurs.
- FinderException - In the execution of the method, a finder exception occurs.
- NamingException - In the execution of the method, a naming exception occurs.
- RemoteException - In the execution of the method, a remote exception occurs.
- javax.naming.NamingException - The javax.naming.NamingException exception
- java.rmi.RemoteException - The java.rmi.RemoteException exception
getDefiningAttributes
public AttributeAccessBean[] getDefiningAttributes()
throws javax.ejb.FinderException,
javax.ejb.CreateException,
javax.naming.NamingException,
java.rmi.RemoteException
- Gets a list of beans that represent defining attributes of the product.
-
- Returns:
- The list of AttributeAccessBean.
- Throws:
- CreateException - In the execution of the method, a create exception occurs.
- FinderException - In the execution of the method, a finder exception occurs.
- NamingException - In the execution of the method, a naming exception occurs.
- RemoteException - In the execution of the method, a remote exception occurs.
getDescriptiveAttributes
public AttributeAccessBean[] getDescriptiveAttributes()
throws javax.ejb.FinderException,
javax.ejb.CreateException,
javax.naming.NamingException,
java.rmi.RemoteException
- Gets a list of beans that represent descriptive attributes of the product.
-
- Returns:
- The list of AttributeAccessBean.
- Throws:
- CreateException - In the execution of the method, a create exception occurs.
- FinderException - In the execution of the method, a finder exception occurs.
- NamingException - In the execution of the method, a naming exception occurs.
- RemoteException - In the execution of the method, a remote exception occurs.
getBundleAccessories
public RelatedBundleDataBean[] getBundleAccessories()
throws ECException
- Gets a list of beans that represent bundles that are accessories to this product.
-
- Specified by:
- getBundleAccessories in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedBundleDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getBundleCrossSells
public RelatedBundleDataBean[] getBundleCrossSells()
throws ECException
- Gets a list of beans that represent bundles that are cross-sells to this product.
-
- Specified by:
- getBundleCrossSells in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedBundleDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getBundleUpSells
public RelatedBundleDataBean[] getBundleUpSells()
throws ECException
- Gets a list of beans that represent bundles that are up-sells to this product.
-
- Specified by:
- getBundleUpSells in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedBundleDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getCalculatedContractPrice
public PriceDataBean getCalculatedContractPrice()
throws ECException
- Gets a PriceDataBean object that represents the the calculated contract price for the product.
-
- Specified by:
- getCalculatedContractPrice in interface ProductSmartDataBean
-
- Returns:
- The PriceDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getCalculatedPrice
public PriceDataBean getCalculatedPrice()
throws ECException
- Gets a PriceDataBean object that represents the calculated price for the product.
-
- Specified by:
- getCalculatedPrice in interface ProductSmartDataBean
-
- Returns:
- The PriceDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getCommandContext
public CommandContext getCommandContext()
- Gets the current command's context passed in at run time.
-
- Specified by:
- getCommandContext in interface SmartDataBean
-
- Returns:
- The command context as CommandContext object.
getDescription
public CatalogEntryDescriptionAccessBean getDescription()
throws javax.ejb.CreateException,
java.rmi.RemoteException,
javax.naming.NamingException,
javax.ejb.FinderException
- Gets a bean representing descriptive information about this product.
-
- Specified by:
- getDescription in interface ProductSmartDataBean
- Overrides:
- getDescription in class ProductAccessBean
-
- Returns:
- The CatalogEntryDescriptionAccessBean.
- Throws:
- CreateException - In the execution of the method, a create exception occurs.
- FinderException - In the execution of the method, a finder exception occurs.
- NamingException - In the execution of the method, a naming exception occurs.
- RemoteException - In the execution of the method, a remote exception occurs.
getDisplayTaxes
public CategorizedMonetaryAmountsDataBean getDisplayTaxes()
throws ECException
- Invokes the getTaxes method in PriceDataBean to calculate the taxes for those tax categories that are displayable at product display time.
-
- Specified by:
- getDisplayTaxes in interface ProductSmartDataBean
-
- Returns:
- The CategorizedMonetaryAmountsDataBean containing the taxing monetary amounts, names and descriptions.
- Throws:
- ECException - An exception occurs during the execution of the method.
getEntitledItems
public ItemDataBean[] getEntitledItems()
throws ECException
- Gets a list of beans that represent items that are entitled to be seen by the user who is browsing this product.
-
- Returns:
- The list of ItemDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getErrorMode
public boolean getErrorMode()
- Gets the error mode.
-
- Returns:
- true if the error mode is set; false otherwise.
getDynamicKitAccessories
public RelatedDynamicKitDataBean[] getDynamicKitAccessories()
throws ECException
- Gets a list of beans that represent dynamic kits that are accessories.
-
- Returns:
- The list of RelatedDynamicKitDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getDynamicKitCrossSells
public RelatedDynamicKitDataBean[] getDynamicKitCrossSells()
throws ECException
- Gets a list of beans that represent dynamic kits that are cross-sells.
-
- Returns:
- The list of RelatedDynamicKitDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getDynamicKitUpSells
public RelatedDynamicKitDataBean[] getDynamicKitUpSells()
throws ECException
- Gets a list of beans that represent dynamic kits that are up-sells.
-
- Returns:
- The list of RelatedDynamicKitDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getItemAccessories
public RelatedItemDataBean[] getItemAccessories()
throws ECException
- Gets a list of beans that represent items that are accessories to this product.
-
- Specified by:
- getItemAccessories in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedItemDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getItemCrossSells
public RelatedItemDataBean[] getItemCrossSells()
throws ECException
- Gets a list of beans that represent items that are cross-sells to this product.
-
- Specified by:
- getItemCrossSells in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedItemDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getItemUpSells
public RelatedItemDataBean[] getItemUpSells()
throws ECException
- Gets a list of beans that represent items that are up-sells to this product.
-
- Specified by:
- getItemUpSells in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedItemDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getListPrice
public PriceDataBean getListPrice()
throws ECException,
javax.ejb.FinderException,
javax.ejb.CreateException,
javax.naming.NamingException,
java.rmi.RemoteException
- Gets a bean that represents the list price for the product.
-
- Specified by:
- getListPrice in interface ProductSmartDataBean
-
- Returns:
- The PriceDataBean.
- Throws:
- CreateException - In the execution of the method, a create exception occurs.
- FinderException - In the execution of the method, a finder exception occurs.
- NamingException - In the execution of the method, a naming exception occurs.
- RemoteException - In the execution of the method, a remote exception occurs.
- ECException
getObjectPath
public java.lang.String getObjectPath()
throws ECException
- Gets the path to objects such as images in the context of the current store.
-
- Returns:
- The path to objects in the current store
- Throws:
- ECException - An exception occurs during the execution of the method.
getPackageAccessories
public RelatedPackageDataBean[] getPackageAccessories()
throws ECException
- Gets a list of beans that represent packages that are accessories to this product.
-
- Specified by:
- getPackageAccessories in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedPackageDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getPackageCrossSells
public RelatedPackageDataBean[] getPackageCrossSells()
throws ECException
- Gets a list of beans that represent packages that are cross-sells to this product.
-
- Specified by:
- getPackageCrossSells in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedPackageDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getPackageUpSells
public RelatedPackageDataBean[] getPackageUpSells()
throws ECException
- Gets a list of beans that represent packages that are up-sells to this product.
-
- Specified by:
- getPackageUpSells in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedPackageDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getPartNumber
public java.lang.String getPartNumber()
- Gets the part (SKU) number of the product.
-
- Specified by:
- getPartNumber in interface ProductSmartDataBean
- Overrides:
- getPartNumber in class ProductAccessBean
-
- Returns:
- The part (SKU) number.
getProductAccessories
public RelatedProductDataBean[] getProductAccessories()
throws ECException
- Gets a list of beans that represent products that are accessories to this product.
-
- Specified by:
- getProductAccessories in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedProductDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getProductCrossSells
public RelatedProductDataBean[] getProductCrossSells()
throws ECException
- Gets a list of beans that represent products that are cross-sells to this product.
-
- Specified by:
- getProductCrossSells in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedProductDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getProductID
public java.lang.String getProductID()
- Gets the product ID that represents the primary key for this product.
-
- Specified by:
- getProductID in interface ProductSmartDataBean
-
- Returns:
- The product ID.
getProductUpSells
public RelatedProductDataBean[] getProductUpSells()
throws ECException
- Gets a list of beans that represent products that are up-sells to this product.
-
- Specified by:
- getProductUpSells in interface ProductSmartDataBean
-
- Returns:
- The list of RelatedProductDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getPublishedItems
public ItemDataBean[] getPublishedItems()
throws ECException
- Gets a list of beans that represent the items for this product.
-
- Returns:
- The list of ItemDataBean.
- Throws:
- ECException - An exception occurs during the execution of the method.
getRequestProperties
public TypedProperty getRequestProperties()
- Gets the request property.
-
- Specified by:
- getRequestProperties in interface InputDataBean
-
- Returns:
- The request property as TypedProperty object.
populate
public void populate()
throws java.lang.Exception
- Fetches and populates information needed by the bean.
-
- Specified by:
- populate in interface SmartDataBean
-
- Throws:
- java.lang.Exception - An exception occurs during the execution of the method.
getProductReplacements
public RelatedProductDataBean[] getProductReplacements()
throws ECException
- Gets a list of beans that represent products that are replacements to this product.
-
- Returns:
- The list of RelatedProductDatabean.
- Throws:
- ECException - An exception occurs during the execution of the method.
setCommandContext
public void setCommandContext(CommandContext aCommandContext)
- Sets the command context passed in at run time.
-
- Specified by:
- setCommandContext in interface SmartDataBean
-
- Parameters:
- aCommandContext - The command context as CommandContext object.
setDescription
public void setDescription(CatalogEntryDescriptionAccessBean aabDescription)
- Sets the descriptive information object about this product.
-
- Parameters:
- aabDescription - The CatalogEntryDescriptionAccessBean.
setErrorMode
public void setErrorMode(boolean aErrorMode)
- Sets the error mode.
-
- Specified by:
- setErrorMode in interface ProductInputDataBean
-
- Parameters:
- aErrorMode - true to have the error mode sets; false otherwise.
setPartNumber
public void setPartNumber(java.lang.String astrProductPartNumber)
- Sets the product part (SKU) number.
-
- Specified by:
- setPartNumber in interface ProductInputDataBean
- Overrides:
- setPartNumber in class ProductAccessBean
-
- Parameters:
- astrProductPartNumber - The part (SKU) number.
setProductID
public void setProductID(java.lang.String astrProductId)
- Sets the product ID that represents the primary key for this product.
-
- Specified by:
- setProductID in interface ProductInputDataBean
-
- Parameters:
- astrProductId - The product ID.
setRequestProperties
public void setRequestProperties(TypedProperty aParam)
- Sets the request properties and populates the parameters that are needed by the bean.
-
- Specified by:
- setRequestProperties in interface InputDataBean
-
- Parameters:
- aParam - The request property as TypedProperty object.
isAdminMode
public boolean isAdminMode()
- Gets the administrative mode of the bean. false is the default.
-
- Returns:
- true if the administrative mode is set; false otherwise.
setAdminMode
public void setAdminMode(boolean aboolAdminMode)
- Sets the administrative mode of the bean. false is the default.
Feedback
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.