com.ibm.commerce.catalog.beans
Class PackageDataBean

java.lang.Object
  |
  +--com.ibm.commerce.catalog.objects.PackageAccessBean
        |
        +--com.ibm.commerce.catalog.beans.PackageDataBean

public class PackageDataBean
extends com.ibm.commerce.catalog.objects.PackageAccessBean

This data bean represents a Package.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Constructor Summary
PackageDataBean()
          Constructs an empty PackageDataBean.
PackageDataBean( CatalogEntryAccessBean abCatentry)
          Constructs a PackageDataBean from a CatalogEntryAccessBean.
PackageDataBean( CatalogEntryAccessBean abCatEntry, CommandContext aCommandContext)
          Constructs a PackageDataBean from a CatalogEntryAccessBean and a command context.
 
Method Summary
 java.lang.Long[] getApplicableContractIds()
          Gets a list of applicable contracts for calculating the prices.
  PriceDataBean[] getApplicableContractPrices()
          Gets a list of price of the applicable contracts 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 package.
  RelatedBundleDataBean[] getBundleCrossSells()
          Gets a list of beans that represent bundles that are cross-sells to this package.
  RelatedBundleDataBean[] getBundleUpSells()
          Gets a list of beans that represent bundles that are up-sells to this package.
  PriceDataBean getCalculatedContractPrice()
          Gets a PriceDataBean that represents the the calculated contract price for the package.
  PriceDataBean getCalculatedPrice()
          Gets a PriceDataBean that represents the the calculated price for the package.
  CommandContext getCommandContext()
          Gets the current command's context passed in at run time.
  CatalogEntryDescriptionAccessBean getDescription()
          Gets a bean representing descriptive information about this package.
  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.
  RelatedItemDataBean[] getItemAccessories()
          Gets a list of beans that represent items that are accessories to this package.
  RelatedItemDataBean[] getItemCrossSells()
          Gets a list of beans that represent items that are cross-sells to this package.
  RelatedItemDataBean[] getItemUpSells()
          Gets a list of beans that represent items that are up-sells to this package.
  PriceDataBean getListPrice()
          Gets a bean that represents the list price for the package.
 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 package.
  RelatedPackageDataBean[] getPackageCrossSells()
          Gets a list of beans that represent packages that are cross-sells to this package.
  CompositeItemDataBean[] getPackagedItems()
          Gets a list of beans that represent items that are components of this package.
  CompositeProductDataBean[] getPackagedProducts()
          Gets a list of beans that represent products that are components of this package.
 java.lang.String getPackageID()
          Gets the package ID that represents the primary key for this package.
protected  java.lang.String getPackagePartNumber()
          Gets the part (SKU) number of the package.
  RelatedPackageDataBean[] getPackageReplacements()
          Gets a list of beans that represent packages that are replacementss to this package.
  RelatedPackageDataBean[] getPackageUpSells()
          Gets a list of beans that represent packages that are up-sells to this package.
  RelatedProductDataBean[] getProductAccessories()
          Gets a list of beans that represent products that are accessories to this package.
  RelatedProductDataBean[] getProductCrossSells()
          Gets a list of beans that represent products that are cross-sells to this package.
  RelatedProductDataBean[] getProductUpSells()
          Gets a list of beans that represent products that are up-sells to this package.
  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 flag of the bean.
 void setCommandContext( CommandContext aCommandContext)
          Sets the command context.
 void setDescription( CatalogEntryDescriptionAccessBean aabDescription)
          Sets the descriptive information about this package.
 void setPackageID(java.lang.String astrPackageId)
          Sets the package ID that represents the primary key for this package.
 void setPackagePartNumber(java.lang.String astrPackagePartNumber)
          Sets the package 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 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

PackageDataBean

public PackageDataBean()
Constructs an empty PackageDataBean.

PackageDataBean

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

PackageDataBean

public PackageDataBean(CatalogEntryAccessBean abCatEntry,
CommandContext aCommandContext)
                throws java.rmi.RemoteException,
                       javax.ejb.FinderException,
                       javax.naming.NamingException,
                       javax.ejb.CreateException
Constructs a PackageDataBean 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.
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 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.

getApplicableContractIds

public java.lang.Long[] getApplicableContractIds()
                                          throws ECException
Gets a list of applicable contracts 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 price of the applicable contracts for calculating the prices.
Returns:
The list of PriceDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getBundleAccessories

public RelatedBundleDataBean[] getBundleAccessories()
                                             throws ECException
Gets a list of beans that represent bundles that are accessories to this package.
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 package.
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 package.
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 package.
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 package.
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,
                                                        java.rmi.RemoteException,
                                                        javax.naming.NamingException,
                                                        javax.ejb.FinderException
Gets a bean representing descriptive information about this package.
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.
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 package.
Returns:
The 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 package.
Returns:
The 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 package.
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 package.
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 package.
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 package.
Returns:
The list of RelatedPackageDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getPackagedItems

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

getPackagedProducts

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

getPackageID

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

getPackagePartNumber

protected java.lang.String getPackagePartNumber()
Gets the part (SKU) number of the package.
Returns:
The part (SKU) code.

getPackageUpSells

public RelatedPackageDataBean[] getPackageUpSells()
                                           throws ECException
Gets a list of beans that represent packages that are up-sells to this package.
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 package.
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 package.
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 package.
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 a TypedProperty object.

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.

getPackageReplacements

public RelatedPackageDataBean[] getPackageReplacements()
                                                throws ECException
Gets a list of beans that represent packages that are replacementss to this package.
Returns:
The list of RelatedPackageDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

setCommandContext

public void setCommandContext(CommandContext aCommandContext)
Sets the command context.
Parameters:
aCommandContext - The command context as CommandContext object.

setDescription

public void setDescription(CatalogEntryDescriptionAccessBean aabDescription)
Sets the descriptive information about this package.
Parameters:
aabDescription - The description to be set as a CatalogEntryDescriptionAccessBean object.

setPackageID

public void setPackageID(java.lang.String astrPackageId)
Sets the package ID that represents the primary key for this package.
Parameters:
astrPackageId - The package ID.

setPackagePartNumber

public void setPackagePartNumber(java.lang.String astrPackagePartNumber)
Sets the package part (SKU) number.
Parameters:
astrPackagePartNumber - The part (SKU) number of the package.

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. false is the default.
Returns:
true if the bean is running in administrative mode; false otherwise.

setAdminMode

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