com.ibm.commerce.catalog.beans
Class ItemDataBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
        |
        +--com.ibm.commerce.catalog.objects.ItemAccessBean
              |
              +--com.ibm.commerce.catalog.beans.ItemDataBean
All Implemented Interfaces:
ItemAccessBeanData

public class ItemDataBean
extends ItemAccessBean

This data bean represents a catalog entry of type Item.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Constructor Summary
ItemDataBean()
          Constructs an empty ItemDataBean.
ItemDataBean( CatalogEntryAccessBean abCatentry)
          Constructs an ItemDataBean from a CatalogEntryAccessBean.
ItemDataBean( CatalogEntryAccessBean abCatEntry, CommandContext aCommandContext)
          Constructs an ItemDataBean from a CatalogEntryAccessBean and a command context.
ItemDataBean( ItemAccessBean abItem, CommandContext aCommandContext)
          Constructs an ItemDataBean from an ItemAccessBean 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 prices of applicable contracts for calculating the prices.
  AttributeAccessBean[] getAttributes()
          Gets a list of beans that represent attributes of the item.
  AttributeValueDataBean[] getAttributeValueDataBeans(java.lang.Integer argLanguageId)
          Gets a list of beans that represent packages that are accessories to this item.
  RelatedBundleDataBean[] getBundleAccessories()
          Gets a list of beans that represent bundles that are accessories to this item.
  RelatedBundleDataBean[] getBundleCrossSells()
          Gets a list of beans that represent bundles that are cross-sells to this item.
  RelatedBundleDataBean[] getBundleUpSells()
          Gets a list of beans that represent bundles that are up-sells to this item.
  PriceDataBean getCalculatedContractPrice()
          Gets a PriceDataBean that represents the the calculated contract price for the item.
  PriceDataBean getCalculatedPrice()
          Gets a PriceDataBean that represents the the calculated price for the item.
  CommandContext getCommandContext()
          Gets the current command's context passed in at run time.
  CatalogEntryDescriptionAccessBean getDescription()
          Gets a bean representing descriptive information about this item.
  AttributeAccessBean[] getDescriptiveAttributes()
          Gets a list of beans that represent descriptive attributes of the item.
  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.
 boolean getErrorMode()
          Gets the error mode.
  RelatedItemDataBean[] getItemAccessories()
          Gets a list of beans that represent items that are accessories to this item.
  RelatedItemDataBean[] getItemCrossSells()
          Gets a list of beans that represent items that are cross-sells to this item.
 java.lang.String getItemID()
          Gets the item ID that represents the primary key for this item.
  RelatedItemDataBean[] getItemReplacements()
          Gets a list of beans that represent items that are replacements to this item.
  RelatedItemDataBean[] getItemUpSells()
          Gets a list of beans that represent items that are up-sells to this item.
  PriceDataBean getListPrice()
          Gets a bean that represents the list price for the item.
 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 item.
  RelatedPackageDataBean[] getPackageCrossSells()
          Gets a list of beans that represent packages that are cross-sells to this item.
  RelatedPackageDataBean[] getPackageUpSells()
          Gets a list of beans that represent packages that are up-sells to this item.
 java.lang.String getPartNumber()
          Gets the part (SKU) number of the item.
  RelatedProductDataBean[] getProductAccessories()
          Gets a list of beans that represent products that are accessories to this item.
  RelatedProductDataBean[] getProductCrossSells()
          Gets a list of beans that represent products that are cross-sells to this item.
  RelatedProductDataBean[] getProductUpSells()
          Gets a list of beans that represent products that are up-sells to this item.
  TypedProperty getRequestProperties()
          Gets the request property.
 boolean isAdminMode()
          Gets if the bean is running in administrative mode.
 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 about this item.
 void setErrorMode(boolean aErrorMode)
          Sets the error mode.
 void setItemID(java.lang.String astrItemId)
          Sets the item ID that represents the primary key for this item.
 void setPartNumber(java.lang.String astrItemPartNumber)
          Sets the item part (SKU) number
 void setRequestProperties( TypedProperty aParam)
          Sets the request property and populates the parameters that are needed by the bean.
 
Methods inherited from class com.ibm.commerce.catalog.objects. ItemAccessBean
commitCopyHelper, defaultJNDIName, findByItemSpcId, findByItemSpcIdAndStore, findByProduct, findEntitledItemsByProduct, findSkuByAttributes, fulfills, getAttributeValues, 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, getField1, getField1InEJBType, getField2, getField2InEJBType, getField3, getField3InEJBType, getField4, getField5, 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
 

Field Detail
public static final java.lang.String COPYRIGHT
The internal copyright field.
See Also:
Constant Field Values
Constructor Detail

ItemDataBean

public ItemDataBean()
Constructs an empty ItemDataBean.

ItemDataBean

public ItemDataBean(CatalogEntryAccessBean abCatentry)
             throws javax.ejb.CreateException,
                    java.rmi.RemoteException,
                    javax.ejb.FinderException,
                    javax.naming.NamingException
Constructs an ItemDataBean 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.

ItemDataBean

public ItemDataBean(CatalogEntryAccessBean abCatEntry,
CommandContext aCommandContext)
             throws javax.ejb.CreateException,
                    java.rmi.RemoteException,
                    javax.ejb.FinderException,
                    javax.naming.NamingException
Constructs an ItemDataBean from a CatalogEntryAccessBean and a command context.
Parameters:
abCatEntry - The CatalogEntryAccessBean.
aCommandContext - The command context as CommandContext object.

ItemDataBean

public ItemDataBean(ItemAccessBean abItem,
CommandContext aCommandContext)
             throws javax.ejb.CreateException,
                    java.rmi.RemoteException,
                    javax.ejb.FinderException,
                    javax.naming.NamingException
Constructs an ItemDataBean from an ItemAccessBean and a command context.
Parameters:
abItem - The ItemAccessBean.
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.
Method Detail

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 item.
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 item.
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.

getApplicableContractIds

public java.lang.Long[] getApplicableContractIds()
                                          throws ECException
Gets a list of applicable contract IDs for calculating the prices.
Returns:
The list of contract IDs.
Throws:
ECException - An exception occurs during the execution of the method. An exception occurs during the execution of the method.

getApplicableContractPrices

public PriceDataBean[] getApplicableContractPrices()
                                            throws ECException
Gets a list of prices of applicable contracts for calculating the prices.
Returns:
The list of PriceDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getAttributeValueDataBeans

public AttributeValueDataBean[] getAttributeValueDataBeans(java.lang.Integer argLanguageId)
                                                    throws javax.ejb.CreateException,
                                                           javax.ejb.FinderException,
                                                           java.rmi.RemoteException,
                                                           javax.naming.NamingException,
                                                           java.lang.Exception
Gets a list of beans that represent packages that are accessories to this item.
Returns:
The list of RelatedPackageDataBean.
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.
java.lang.Exception

getBundleAccessories

public RelatedBundleDataBean[] getBundleAccessories()
                                             throws ECException
Gets a list of beans that represent bundles that are accessories to this item.
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 item.
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 item.
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 that represents the the calculated contract price for the item.
Returns:
The PriceDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getCalculatedPrice

public PriceDataBean getCalculatedPrice()
                                 throws ECException
Gets a PriceDataBean that represents the the calculated price for the item.
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.
Returns:
The command context as CommandContext object.

getDescription

public CatalogEntryDescriptionAccessBean getDescription()
                                                 throws javax.ejb.CreateException,
                                                        javax.naming.NamingException,
                                                        java.rmi.RemoteException,
                                                        javax.ejb.FinderException
Gets a bean representing descriptive information about this item.
Overrides:
getDescription in class ItemAccessBean
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.
Returns:
The CategorizedMonetaryAmountsDataBean containing the taxing monetary amounts, names and descriptions, and so on.
Throws:
ECException - An exception occurs during the execution of the method.

getErrorMode

public boolean getErrorMode()
Gets the error mode. true is the default.
Returns:
true if 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 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 item.
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 item.
Returns:
The list of RelatedItemDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getItemID

public java.lang.String getItemID()
Gets the item ID that represents the primary key for this item.
Returns:
The item ID.

getItemUpSells

public RelatedItemDataBean[] getItemUpSells()
                                     throws ECException
Gets a list of beans that represent items that are up-sells to this item.
Returns:
The 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 item.
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 item.
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 item.
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 item.
Returns:
The 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 item.
Specified by:
getPartNumber in interface ItemAccessBeanData
Overrides:
getPartNumber in class ItemAccessBean
Returns:
The part (SKU) number of the item.

getProductAccessories

public RelatedProductDataBean[] getProductAccessories()
                                               throws ECException
Gets a list of beans that represent products that are accessories to this item.
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 item.
Returns:
The RelatedProductDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getProductUpSells

public RelatedProductDataBean[] getProductUpSells()
                                           throws ECException
Gets a list of beans that represent products that are up-sells to this item.
Returns:
The list of RelatedProductDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getRequestProperties

public TypedProperty getRequestProperties()
Gets the request property.
Returns:
The request property as TypedProperty object. Always returns null.

populate

public void populate()
              throws java.lang.Exception
Fetches and populates information needed by the bean.
Throws:
java.lang.Exception - An exception occurs during the execution of the method.

getItemReplacements

public RelatedItemDataBean[] getItemReplacements()
                                          throws ECException
Gets a list of beans that represent items that are replacements to this item.
Returns:
The list of RelatedItemDataBean.
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.
Parameters:
aCommandContext - The command context as CommandContext object.

setDescription

public void setDescription(CatalogEntryDescriptionAccessBean aabDescription)
Sets the descriptive information about this item.
Parameters:
aabDescription - The CatalogEntryDescriptionAccessBean.

setErrorMode

public void setErrorMode(boolean aErrorMode)
Sets the error mode.

setItemID

public void setItemID(java.lang.String astrItemId)
Sets the item ID that represents the primary key for this item.
Parameters:
astrItemId - The item ID.

setPartNumber

public void setPartNumber(java.lang.String astrItemPartNumber)
Sets the item part (SKU) number
Specified by:
setPartNumber in interface ItemAccessBeanData
Overrides:
setPartNumber in class ItemAccessBean
Parameters:
astrItemPartNumber - The part (SKU) number of the item.
Returns:
void

setRequestProperties

public void setRequestProperties(TypedProperty aParam)
Sets the request property and populates the parameters that are needed by the bean.
Parameters:
aParam - The request property as a TypedProperty object.

isAdminMode

public boolean isAdminMode()
Gets if the bean is running in administrative mode.
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.