com.ibm.commerce.catalog.beans
Class CatalogEntryDataBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
        |
        +--com.ibm.commerce.catalog.objects.CatalogEntryAccessBean
              |
              +--com.ibm.commerce.catalog.beans.CatalogEntryDataBean
All Implemented Interfaces:
CatalogEntryAccessBeanData
Direct Known Subclasses:
EMarketingSpot.AssociateCatalogEntry, EMarketingSpot.CatalogEntry

public class CatalogEntryDataBean
extends CatalogEntryAccessBean

This data bean represents a Generic Catalog Entry. Use this databean in place of a more specific databean (for example ProductDataBean, ItemDataBean) when the type of Catalog Entry is not known.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Constructor Summary
CatalogEntryDataBean()
          Constructs an empty CatalogEntryDataBean object.
CatalogEntryDataBean( CatalogEntryAccessBean abCatentry)
          Constructs a CatalogEntryDataBean from a CatalogEntryAccessBean.
CatalogEntryDataBean( CatalogEntryAccessBean abCatEntry, CommandContext aCommandContext)
          Constructs an CatalogEntryDataBean 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 the prices for the applicable contracts.
  AttributeAccessBean[] getAttributes()
          Gets a list of beans that represent attributes of the catalof entry.
  RelatedBundleDataBean[] getBundleAccessories()
          Gets a list of beans that represent bundles that are accessories to this catalog entry.
  RelatedBundleDataBean[] getBundleCrossSells()
          Gets a list of beans that represent bundles that are cross-sells to this catalog entry.
  RelatedBundleDataBean[] getBundleUpSells()
          Gets a list of beans that represent bundles that are up-sells to this catalog entry.
  PriceDataBean getCalculatedContractPrice()
          Gets a PriceDataBean that represents the calculated contract price for the item.
  PriceDataBean getCalculatedPrice()
          Gets a PriceDataBean that represents the the calculated price for the catalog entry.
 java.lang.String getCatalogEntryID()
          Gets the ID that represents the primary key for this catalog entry.
  CommandContext getCommandContext()
          Gets the current command's context.
  CatalogEntryDescriptionAccessBean getDescription()
          Gets a bean representing descriptive information about this catalog entry.
  AttributeAccessBean[] getDescriptiveAttributes()
          Gets a list of beans that represent descriptive attributes of the catalog entry.
 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.
 java.lang.String getEndDay()
          Gets the day portion of the timestamp for end date.
 java.lang.String getEndMonth()
          Gets the month portion of the timestamp for end date.
 java.lang.String getEndYear()
          Gets the year portion of the timestamp for end date.
  RelatedItemDataBean[] getItemAccessories()
          Gets a list of beans that represent items that are accessories to this catalog entry.
  RelatedItemDataBean[] getItemCrossSells()
          Gets a list of beans that represent items that are cross-sells to this catalog entry.
  RelatedItemDataBean[] getItemUpSells()
          Gets a list of beans that represent items that are up-sells to this catalog entry.
  PriceDataBean getListPrice()
          Gets a bean that represents the list price for the catalog entry.
 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 catalog entry.
  RelatedPackageDataBean[] getPackageCrossSells()
          Gets a list of beans that represent packages that are cross-sells to this catalog entry.
  RelatedPackageDataBean[] getPackageUpSells()
          Gets a list of beans that represent packages that are up-sells to this catalog entry.
 java.lang.String getPartNumber()
          Gets the part (SKU) number of the catalog entry.
  RelatedProductDataBean[] getProductAccessories()
          Gets a list of beans that represent products that are accessories to this catalog entry.
  RelatedProductDataBean[] getProductCrossSells()
          Gets a list of beans that represent products that are cross-sells to this catalog entry.
  RelatedProductDataBean[] getProductUpSells()
          Gets a list of beans that represent products that are up-sells to this catalog entry.
  TypedProperty getRequestProperties()
          Gets the request property passed in at run time.
 CatalogEntryShippingAccessBean getShipping()
          Gets the access bean which represents the shipping information for this catalog entry.
 java.lang.String getStartDay()
          Gets the day portion of the timestamp for start date.
 java.lang.String getStartMonth()
          Gets the month portion of the timestamp for start date.
 java.lang.String getStartYear()
          Gets the year portion of the timestamp for start date.
 void populate()
          Fetches and populates information needed by the bean.
 void setCatalogEntryID(java.lang.String astrCatEntryId)
          Sets the ID that represents the primary key for this catalog entry.
 void setCommandContext( CommandContext aCommandContext)
          Sets the command context passed in at run time.
 void setDescription( CatalogEntryDescriptionAccessBean aabDescription)
          Sets the description bean.
 void setPartNumber(java.lang.String astrItemPartNumber)
          Sets the catalog entry part (SKU) number.
 void setRequestProperties( TypedProperty aParam)
          Sets the request property and populates the parameters that are needed by the bean.
 void setShipping(CatalogEntryShippingAccessBean aabShipping)
          Sets the shipping bean.
 
Methods inherited from class com.ibm.commerce.catalog.objects. CatalogEntryAccessBean
commitCopyHelper, defaultJNDIName, findByAttributeValueWithAttributeId, findByAttributeValueWithAttributeIdAndStore, findByBaseItemId, findByBaseItemIdAndStore, findByCatalog, findByCatalogAndGroup, findByCatalogAndGroupAndStore, findByCatalogAndStore, findByCatalogEntryIds, findByCatalogEntryIdsAndStore, findByChildCatalogEntry, findByChildCatalogEntryAndStore, findByItemSpcId, findByItemSpcIdAndStore, findByKeyAndStore, findByMemberId, findByMemberIdAndSKUNumber, findBySKUNumberAndStore, findEntitledCatalogEntryByCatalogAndGroup, findEntitledCatalogEntryByCatalogAndGroupAndStore, findEntitledCatalogEntryByCatalogAndGroupAndStoreOrderByPartNumber, findWithPushDownQuery, fulfills, 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

CatalogEntryDataBean

public CatalogEntryDataBean()
Constructs an empty CatalogEntryDataBean object.

CatalogEntryDataBean

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

CatalogEntryDataBean

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

getApplicableContractPrices

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

getCatalogEntryID

public java.lang.String getCatalogEntryID()
Gets the ID that represents the primary key for this catalog entry.
Returns:
The catalog entry ID.

getCommandContext

public CommandContext getCommandContext()
Gets the current command's context.
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 catalog entry.
Overrides:
getDescription in class CatalogEntryAccessBean
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.
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.naming.NamingException - The javax.naming.NamingException exception

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 catalog entry.
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 catalog entry.
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 catalog entry.
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 catalog entry.
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 - An exception occurs during the execution of the method.

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 catalog entry.
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 catalog entry.
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 catalog entry.
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 catalog entry.
Specified by:
getPartNumber in interface CatalogEntryAccessBeanData
Overrides:
getPartNumber in class CatalogEntryAccessBean
Returns:
The part number of the catalog entry.

getProductAccessories

public RelatedProductDataBean[] getProductAccessories()
                                               throws ECException
Gets a list of beans that represent products that are accessories to this catalog entry.
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 catalog entry.
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 catalog entry.
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:
Always returns null.

getShipping

public CatalogEntryShippingAccessBean getShipping()
Gets the access bean which represents the shipping information for this catalog entry.
Returns:
The CatalogEntryShippingAccessBean.

getStartYear

public java.lang.String getStartYear()
                              throws java.lang.Exception
Gets the year portion of the timestamp for start date.
Returns:
The year part of the start date.
Throws:
java.lang.Exception - An exception occurs during the execution of the method.

getStartMonth

public java.lang.String getStartMonth()
                               throws java.lang.Exception
Gets the month portion of the timestamp for start date.
Returns:
The month part of the start date.
Throws:
java.lang.Exception - An exception occurs during the execution of the method.

getStartDay

public java.lang.String getStartDay()
                             throws java.lang.Exception
Gets the day portion of the timestamp for start date.
Returns:
The day part of the start date.
Throws:
java.lang.Exception - An exception occurs during the execution of the method.

getEndYear

public java.lang.String getEndYear()
                            throws java.lang.Exception
Gets the year portion of the timestamp for end date.
Returns:
The year part of the end date.
Throws:
java.lang.Exception - An exception occurs during the execution of the method.

getEndMonth

public java.lang.String getEndMonth()
                             throws java.lang.Exception
Gets the month portion of the timestamp for end date.
Returns:
The month part of the end date.
Throws:
java.lang.Exception - An exception occurs during the execution of the method.

getEndDay

public java.lang.String getEndDay()
                           throws java.lang.Exception
Gets the day portion of the timestamp for end date.
Returns:
The day part of the end date.
Throws:
ECException - An exception occurs during the execution of the method.
java.lang.Exception

populate

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

setCatalogEntryID

public void setCatalogEntryID(java.lang.String astrCatEntryId)
Sets the ID that represents the primary key for this catalog entry.
Parameters:
astrCatEntryId - The primary key.

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 description bean.
Parameters:
aabDescription - The bean that represents the description of the catalog entry.

setPartNumber

public void setPartNumber(java.lang.String astrItemPartNumber)
Sets the catalog entry part (SKU) number.
Specified by:
setPartNumber in interface CatalogEntryAccessBeanData
Overrides:
setPartNumber in class CatalogEntryAccessBean
Parameters:
astrItemPartNumber - java.lang.String
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 TypedProperty.

setShipping

public void setShipping(CatalogEntryShippingAccessBean aabShipping)
Sets the shipping bean.
Parameters:
aabShipping - The bean that represents the shipping information for the catalog entry.