com.ibm.commerce.catalog.beans
Class BundleDataBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
        |
        +--com.ibm.commerce.catalog.objects.BundleAccessBean
              |
              +--com.ibm.commerce.catalog.beans.BundleDataBean
All Implemented Interfaces:
BundleAccessBeanData

public class BundleDataBean
extends BundleAccessBean

This bean represents a Bundle.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Constructor Summary
BundleDataBean()
          Constructs an empty BundleDataBean.
BundleDataBean( CatalogEntryAccessBean abCatEntry)
          Creates a BundleDataBean from a CatalogEntryAccessBean.
BundleDataBean( CatalogEntryAccessBean abCatEntry, CommandContext aCommandContext)
          Constructs a BundleDataBean from a CatalogEntryAccessBean and the command context.
 
Method Summary
  AttributeAccessBean[] getAttributes()
          Gets a list of beans that represent attributes of the bundle.
  RelatedBundleDataBean[] getBundleAccessories()
          Gets a list of beans that represent bundles that are accessories to this bundle.
  RelatedBundleDataBean[] getBundleCrossSells()
          Gets a list of beans that represent bundles that are cross-sells to this bundle.
  CompositeItemDataBean[] getBundledItems()
          Gets a list of beans that represent items that are components of this bundle.
  CompositePackageDataBean[] getBundledPackages()
          Gets a list of beans that represent packages that are components of this bundle.
  CompositeProductDataBean[] getBundledProducts()
          Gets a list of beans that represent products that are components of this bundle.
 java.lang.String getBundleID()
          Gets the bundle ID that represents the primary key for this bundle.
 java.lang.String getBundlePartNumber()
          Gets the part (SKU) number of the bundle.
  RelatedBundleDataBean[] getBundleReplacements()
          Gets a list of beans that represent bundles that are replacement to this bundle.
  RelatedBundleDataBean[] getBundleUpSells()
          Gets a list of beans that represent bundles that are up-sells to this bundle.
  PriceDataBean getCalculatedContractPrice()
          Gets a PriceDataBean that represents the sum of the calculated contract prices for each of the bundle components .
  PriceDataBean getCalculatedPrice()
          Gets a PriceDataBean that represents the sum of the calculated prices for each of the bundle components.
  CommandContext getCommandContext()
          Gets the current command's context.
  CatalogEntryDescriptionAccessBean getDescription()
          Gets a bean representing descriptive information about this bundle.
  AttributeAccessBean[] getDescriptiveAttributes()
          Gets a list of beans that represent descriptive attributes of the bundle.
  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.
  RelatedItemDataBean[] getItemAccessories()
          Gets a list of beans that represent items that are accessories to this bundle.
  RelatedItemDataBean[] getItemCrossSells()
          Gets a list of beans that represent items that are cross-sells to this bundle.
  RelatedItemDataBean[] getItemUpSells()
          Gets a list of beans that represent items that are up-sells to this bundle.
  PriceDataBean getListPrice()
          Gets a bean that represents the sum of the list prices for each of the bundle components.
 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 bundle.
  RelatedPackageDataBean[] getPackageCrossSells()
          Gets a list of beans that represent packages that are cross-sells to this bundle.
  RelatedPackageDataBean[] getPackageUpSells()
          Gets a list of beans that represent packages that are up-sells to this bundle.
  RelatedProductDataBean[] getProductAccessories()
          Gets a list of beans that represent products that are accessories to this bundle.
  RelatedProductDataBean[] getProductCrossSells()
          Gets a list of beans that represent products that are cross-sells to this bundle.
  RelatedProductDataBean[] getProductUpSells()
          Gets a list of beans that represent products that are up-sells to this bundle.
  TypedProperty getRequestProperties()
          Gets the request property passed in at run time.
 boolean isAdminMode()
          Is the databean used in the administrative mode.
 void populate()
          Fetches and populates information needed by the bean.
 void setAdminMode(boolean aboolAdminMode)
          Sets the administrative mode.
 void setBundleID(java.lang.String astrBundleId)
          Sets the bundle ID that represents the primary key for this bundle.
 void setBundlePartNumber(java.lang.String astrBundlePartNumber)
          Sets the bundle part (SKU) number.
 void setCommandContext( CommandContext aCommandContext)
          Sets the command context passed in at run time.
 void setDescription( CatalogEntryDescriptionAccessBean aabDescription)
          Sets the descriptive AccessBean CatalogEntryDescriptionAccessBean about this bundle.
 void setRequestProperties( TypedProperty aParam)
          Sets the request properties and populates the parameters that are needed by the bean.
 
Methods inherited from class com.ibm.commerce.catalog.objects. BundleAccessBean
commitCopyHelper, defaultJNDIName, fulfills, getBaseItem, getBaseItemId, getBaseItemIdInEJBType, getBundleComponents, 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, getPartNumber, 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, setPartNumber, 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

BundleDataBean

public BundleDataBean()
Constructs an empty BundleDataBean.

BundleDataBean

public BundleDataBean(CatalogEntryAccessBean abCatEntry)
               throws java.rmi.RemoteException,
                      javax.ejb.FinderException,
                      javax.naming.NamingException,
                      javax.ejb.CreateException
Creates a BundleDataBean from a CatalogEntryAccessBean.
Throws:
RemoteException - In the execution of the method, a remote exception occurs.
FinderException - In the execution of the method, a finder exception occurs.
NamingException - In the execution of the method, a naming exception occurs.
CreateException - In the execution of the method, a create exception occurs.

BundleDataBean

public BundleDataBean(CatalogEntryAccessBean abCatEntry,
CommandContext aCommandContext)
               throws java.rmi.RemoteException,
                      javax.ejb.FinderException,
                      javax.naming.NamingException,
                      javax.ejb.CreateException
Constructs a BundleDataBean from a CatalogEntryAccessBean and the command context.
Parameters:
abCatEntry - The CatalogEntryAccessbean.
aCommandContext - The command context as CommandContext object.
Throws:
RemoteException - In the execution of the method, a remote exception occurs.
FinderException - In the execution of the method, a finder exception occurs.
NamingException - In the execution of the method, a naming exception occurs.
CreateException - In the execution of the method, a create 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 bundle.
Returns:
The list of AttributeAccessBean for the bundle.
Throws:
RemoteException - In the execution of the method, a remote exception occurs.
FinderException - In the execution of the method, a finder exception occurs.
NamingException - In the execution of the method, a naming exception occurs.
CreateException - In the execution of the method, a create 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 bundle.
Returns:
The list of AttributeAccessBean for the bundle.
Throws:
RemoteException - In the execution of the method, a remote exception occurs.
FinderException - In the execution of the method, a finder exception occurs.
NamingException - In the execution of the method, a naming exception occurs.
CreateException - In the execution of the method, a create exception occurs.

getBundleAccessories

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

getBundledItems

public CompositeItemDataBean[] getBundledItems()
                                        throws ECException
Gets a list of beans that represent items that are components of this bundle.
Returns:
The list of CompositeItemDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getBundledPackages

public CompositePackageDataBean[] getBundledPackages()
                                              throws ECException
Gets a list of beans that represent packages that are components of this bundle.
Returns:
The list of CompositePackageDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getBundledProducts

public CompositeProductDataBean[] getBundledProducts()
                                              throws ECException
Gets a list of beans that represent products that are components of this bundle.
Returns:
The list of CompositeProductDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getBundleID

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

getBundlePartNumber

public java.lang.String getBundlePartNumber()
Gets the part (SKU) number of the bundle.
Returns:
The part (SKU) number.

getBundleUpSells

public RelatedBundleDataBean[] getBundleUpSells()
                                         throws ECException
Gets a list of beans that represent bundles that are up-sells to this bundle.
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 sum of the calculated contract prices for each of the bundle components .
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 sum of the calculated prices for each of the bundle components.
Returns:
The PriceDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getCommandContext

public CommandContext getCommandContext()
Gets the current command's context.
Returns:
The command context as CommandContext objects.

getDescription

public CatalogEntryDescriptionAccessBean getDescription()
                                                 throws javax.ejb.CreateException,
                                                        javax.ejb.FinderException,
                                                        java.rmi.RemoteException,
                                                        javax.naming.NamingException
Gets a bean representing descriptive information about this bundle.
Overrides:
getDescription in class BundleAccessBean
Returns:
The CatalogEntryDescriptionAccessBean.
Throws:
RemoteException - In the execution of the method, a remote exception occurs.
FinderException - In the execution of the method, a finder exception occurs.
NamingException - In the execution of the method, a naming exception occurs.
CreateException - In the execution of the method, a create 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.

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 bundle.
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 bundle.
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 bundle.
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 sum of the list prices for each of the bundle components.
Returns:
The PriceDataBean.
ECException
javax.ejb.FinderException
javax.ejb.CreateException
javax.naming.NamingException
java.rmi.RemoteException

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 bundle.
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 bundle.
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 bundle.
Returns:
The list of RelatedPackageDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getProductAccessories

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

getRequestProperties

public TypedProperty getRequestProperties()
Gets the request property passed in at run time.
Returns:
null is always returned.

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.

getBundleReplacements

public RelatedBundleDataBean[] getBundleReplacements()
                                              throws ECException
Gets a list of beans that represent bundles that are replacement to this bundle.
Returns:
The list of RelatedBundleDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

setBundleID

public void setBundleID(java.lang.String astrBundleId)
Sets the bundle ID that represents the primary key for this bundle.
Parameters:
astrBundleId - The bundle ID.

setBundlePartNumber

public void setBundlePartNumber(java.lang.String astrBundlePartNumber)
Sets the bundle part (SKU) number.
Parameters:
astrBundlePartNumber - The bundle part (SKU) number.

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 AccessBean CatalogEntryDescriptionAccessBean about this bundle.
Parameters:
aabDescription - The CatalogEntryDescriptionAccessBean.

setRequestProperties

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

isAdminMode

public boolean isAdminMode()
Is the databean used in the administrative mode. False is the default.
Returns:
True if it is running in administrative mode. False otherwise.

setAdminMode

public void setAdminMode(boolean aboolAdminMode)
Sets the administrative mode.