java.lang.Object | +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean | +--com.ibm.commerce.catalog.objects.ProductAccessBean | +--com.ibm.commerce.catalog.beans.ProductDataBean
This data bean represents a product.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT The internal copyright field. |
Fields inherited from interface com.ibm.commerce.beans. DataBean |
emptyString |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
java.lang.Long[] |
getApplicableContractIds() Gets a list of applicable contract IDs for calculating the prices. |
PriceDataBean[] |
getApplicableContractPrices() Gets a list of the applicable contracts' prices for calculating the prices. |
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[] |
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 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. |
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. |
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[] |
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[] |
getItemCrossSells() Gets a list of beans that represent items that are cross-sells to this 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. |
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[] |
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[] |
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. |
boolean |
isAdminMode() Gets the administrative mode of the bean. |
void |
populate() Fetches and populates information needed by the bean. |
void |
setAdminMode(boolean aboolAdminMode) Sets the administrative mode of the bean. |
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 |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public ProductDataBean()
ProductDataBean
object.
public ProductDataBean(CatalogEntryAccessBean abCatentry) throws javax.ejb.CreateException, java.rmi.RemoteException, javax.ejb.FinderException, javax.naming.NamingException
ProductDataBean
from a
CatalogEntryAccessBean
.
abCatentry
- The CatalogEntryAccessBean
.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.public ProductDataBean(CatalogEntryAccessBean abCatEntry, CommandContext aCommandContext) throws javax.ejb.CreateException, java.rmi.RemoteException, javax.ejb.FinderException, javax.naming.NamingException
ProductDataBean
from a
CatalogEntryAccessBean
and a command context.
abCatEntry
- The CatalogEntryAccessBean
.aCommandContext
- The command context as
CommandContext
object.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.Method Detail |
---|
public java.lang.Long[] getApplicableContractIds() throws ECException
getApplicableContractIds
in interface
ProductSmartDataBean
ECException
- An exception occurs during the execution of the method.public PriceDataBean[] getApplicableContractPrices() throws ECException
getApplicableContractPrices
in interface
ProductSmartDataBean
PriceDatabean
.ECException
- An exception occurs during the execution of the method.public AttributeAccessBean[] getAttributes() throws javax.ejb.FinderException, javax.ejb.CreateException, javax.naming.NamingException, java.rmi.RemoteException
getAttributes
in interface
ProductSmartDataBean
getAttributes
in class
ProductAccessBean
AttributeAccessBean
.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.public AttributeAccessBean[] getDefiningAttributes() throws javax.ejb.FinderException, javax.ejb.CreateException, javax.naming.NamingException, java.rmi.RemoteException
AttributeAccessBean
.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.public AttributeAccessBean[] getDescriptiveAttributes() throws javax.ejb.FinderException, javax.ejb.CreateException, javax.naming.NamingException, java.rmi.RemoteException
AttributeAccessBean
.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.public RelatedBundleDataBean[] getBundleAccessories() throws ECException
getBundleAccessories
in interface
ProductSmartDataBean
RelatedBundleDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedBundleDataBean[] getBundleCrossSells() throws ECException
getBundleCrossSells
in interface
ProductSmartDataBean
RelatedBundleDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedBundleDataBean[] getBundleUpSells() throws ECException
getBundleUpSells
in interface
ProductSmartDataBean
RelatedBundleDataBean
.ECException
- An exception occurs during the execution of the method.public PriceDataBean getCalculatedContractPrice() throws ECException
PriceDataBean
object that represents the the calculated
contract price for the product.
getCalculatedContractPrice
in interface
ProductSmartDataBean
PriceDataBean
.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
ProductSmartDataBean
PriceDataBean
.ECException
- An exception occurs during the execution of the method.public CommandContext getCommandContext()
getCommandContext
in interface
SmartDataBean
CommandContext
object.public CatalogEntryDescriptionAccessBean getDescription() throws javax.ejb.CreateException, java.rmi.RemoteException, javax.naming.NamingException, javax.ejb.FinderException
getDescription
in interface
ProductSmartDataBean
getDescription
in class
ProductAccessBean
CatalogEntryDescriptionAccessBean
.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.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
ProductSmartDataBean
CategorizedMonetaryAmountsDataBean
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[] 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
ProductSmartDataBean
RelatedItemDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemCrossSells() throws ECException
getItemCrossSells
in interface
ProductSmartDataBean
RelatedItemDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemUpSells() throws ECException
getItemUpSells
in interface
ProductSmartDataBean
RelatedItemDataBean
.ECException
- An exception occurs during the execution of the method.public PriceDataBean getListPrice() throws ECException, javax.ejb.FinderException, javax.ejb.CreateException, javax.naming.NamingException, java.rmi.RemoteException
getListPrice
in interface
ProductSmartDataBean
PriceDataBean
.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
public java.lang.String getObjectPath() throws ECException
ECException
- An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageAccessories() throws ECException
getPackageAccessories
in interface
ProductSmartDataBean
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageCrossSells() throws ECException
getPackageCrossSells
in interface
ProductSmartDataBean
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageUpSells() throws ECException
getPackageUpSells
in interface
ProductSmartDataBean
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public java.lang.String getPartNumber()
getPartNumber
in interface
ProductSmartDataBean
getPartNumber
in class
ProductAccessBean
public RelatedProductDataBean[] getProductAccessories() throws ECException
getProductAccessories
in interface
ProductSmartDataBean
RelatedProductDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedProductDataBean[] getProductCrossSells() throws ECException
getProductCrossSells
in interface
ProductSmartDataBean
RelatedProductDataBean
.ECException
- An exception occurs during the execution of the method.public java.lang.String getProductID()
getProductID
in interface
ProductSmartDataBean
public RelatedProductDataBean[] getProductUpSells() throws ECException
getProductUpSells
in interface
ProductSmartDataBean
RelatedProductDataBean
.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
InputDataBean
TypedProperty
object.public void populate() throws java.lang.Exception
populate
in interface
SmartDataBean
java.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
SmartDataBean
aCommandContext
- The command context as
CommandContext
object.public void setDescription(CatalogEntryDescriptionAccessBean aabDescription)
aabDescription
- The
CatalogEntryDescriptionAccessBean
.public void setErrorMode(boolean aErrorMode)
setErrorMode
in interface
ProductInputDataBean
aErrorMode
- true
to have the error mode sets;
false
otherwise.public void setPartNumber(java.lang.String astrProductPartNumber)
setPartNumber
in interface
ProductInputDataBean
setPartNumber
in class
ProductAccessBean
astrProductPartNumber
- The part (SKU)
number.public void setProductID(java.lang.String astrProductId)
setProductID
in interface
ProductInputDataBean
astrProductId
- The product ID.public void setRequestProperties(TypedProperty aParam)
setRequestProperties
in interface
InputDataBean
aParam
- 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.