public class PackageDataBean extends PackageAccessBean implements com.ibm.commerce.catalog.beans.PackageSmartDataBean, com.ibm.commerce.catalog.beans.PackageInputDataBean
You can find more information about data beans in the WebSphere Commerce data beans topic in the Information Center.
Access Beans: Package
Mandatory Parameters (for single row retrieval):
Some hints and tips for using this data bean are:
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
The internal copyright field.
|
emptyString
Constructor and Description |
---|
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. |
Modifier and Type | Method and Description |
---|---|
AttachmentDataBean[] |
getAllAttachments()
Gets all the attachments in the pre-built kit.
|
java.lang.Long[] |
getApplicableContractIds()
Gets a list of applicable contracts for calculating the prices.
|
com.ibm.commerce.catalog.util.RangePricingData[] |
getApplicableContractPriceRanges()
Retrieve the tiered pricing information for the current package in all the applicable contracts.
|
PriceDataBean[] |
getApplicableContractPrices()
Gets a list of price of the applicable contracts for calculating the prices.
|
ContractDataBean[] |
getApplicableContracts()
Gets a list of ContractDataBean that represents applicable contracts for the package.
|
AttachmentDataBean[] |
getAttachmentsByUsage()
Get all the pre-built kit attachments by the specified attachment relation usage.
|
AttachmentUsageDataBean[] |
getAttachmentUsages()
Get all the attachment relation usage used in the pre-built kit attachments
|
AttributeDataBean[] |
getAttributeDataBeans()
Gets a list of data beans that represent attributes of the product.
|
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[] |
getBundleAssociations()
Gets a list of beans that represent bundles that are merchandising associations for 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.
|
AttributeDataBean[] |
getDescriptiveAttributeDataBeans()
Gets a list of data beans that represent descriptive attributes of the product.
|
AttributeAccessBean[] |
getDescriptiveAttributes()
Gets a list of beans that represent descriptive attributes of the product.
|
CategorizedMonetaryAmountsDataBean |
getDisplayTaxes()
Invokes the
getTaxes method in PriceDataBean to calculate the taxes for those
tax categories that are displayable at product display time. |
RelatedDynamicKitDataBean[] |
getDynamicKitAccessories()
Gets a list of beans that represent dynamic kits that are accessories.
|
RelatedDynamicKitDataBean[] |
getDynamicKitAssociations()
Gets a list of beans that represent dynamic kits that are merchandising associations for this package.
|
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[] |
getItemAssociations()
Gets a list of beans that represent items that are merchandising associations for 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.
|
int |
getNumberOfApplicableContractIds()
Gets the number of applicable contract IDs for calculating the prices.
|
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[] |
getPackageAssociations()
Gets a list of beans that represent packages that are merchandising associations for 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.
|
CompositePackageDataBean[] |
getPackagedPackages()
Gets a list of beans that represent packages 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.
|
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[] |
getProductAssociations()
Gets a list of beans that represent products that are merchandising associations for 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.
|
PriceDataBean |
getStandardPrice()
Gets a PriceDataBean that represents the standard contract price for the item.
|
boolean |
isAdminMode()
Gets if the bean is running in administrative mode.
|
boolean |
isAnyMerchandisingAssociated()
Determines whether there are any OOB or custom merchandising associations associated with this catalog entry
|
boolean |
isCalculatedContractPriced()
Determines whether the package has a calculated contract price.
|
boolean |
isCheckNumberOfApplicableContractIds()
Determines whether the package has any applicable contract ids
|
boolean |
isListPriced()
Determines whether the package has a list price.
|
boolean |
isMerchandisingAssociated()
Determines whether there are any merchandising associations associated with this product
|
void |
populate()
Fetches and populates information needed by the bean.
|
void |
setAdminMode(boolean aboolAdminMode)
Sets the administrative mode flag of the bean.
|
void |
setAssociationType(java.lang.String type)
Sets the variable
istrAssociationType , which represents the target association type to be processed by
an internal method called processCatalogEntryAssociation() . |
void |
setAttachmentUsage(java.lang.String astrAttachmentUsage)
Sets the attachment relation usage identifier to get all the attachments of the pre-built kit with the same usage.
|
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.
|
findByAttributes, findByBaseItemId, findByBaseItemIdAndStore, findByItemSpcId, findByItemSpcIdAndStore, findPackageByAttributes, fulfills, getAvailabilityDate, getBaseItem, getBaseItemId, getBaseItemIdInEntityType, getBuyable, getBuyableInEntityType, getCatalogEntriesAccessory, getCatalogEntriesAccessory, getCatalogEntriesAccessory, getCatalogEntriesAccessory, getCatalogEntriesAccessoryByStore, getCatalogEntriesAccessoryByStore, getCatalogEntriesAccessoryByStore, getCatalogEntriesAccessoryByStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesByMAssocTypeAndStore, getCatalogEntriesCrossell, getCatalogEntriesCrossell, getCatalogEntriesCrossell, getCatalogEntriesCrossell, getCatalogEntriesCrossellByStore, getCatalogEntriesCrossellByStore, getCatalogEntriesCrossellByStore, getCatalogEntriesCrossellByStore, getCatalogEntriesUpSell, getCatalogEntriesUpSell, getCatalogEntriesUpSell, getCatalogEntriesUpSell, getCatalogEntriesUpSellByStore, getCatalogEntriesUpSellByStore, getCatalogEntriesUpSellByStore, getCatalogEntriesUpSellByStore, getCatalogEntryReferenceNumber, getCatalogEntryReferenceNumberInEntityType, getDescription, getDescription, getDiscontinueDate, getEndDate, getEndOfServiceDate, getEntity, getField1, getField1InEntityType, getField2, getField2InEntityType, getField3, getField3InEntityType, getField4, getField5, getItemspc_id, getItemspc_idInEntityType, getLanguage_id, getLanguage_idInEntityType, getLastOrderDate, getLastUpdate, getLastUpdateInEntityType, getListPrice, getManufacturerName, getManufacturerPartNumber, getMarkForDelete, getMarkForDeleteInEntityType, getMemberId, getMemberIdInEntityType, getOid, getOnAuction, getOnAuctionInEntityType, getOnSpecial, getOnSpecialInEntityType, getOwner, getPackageAttributes, getPackageComponents, getParentCatalogEntryIds, getPartNumber, getStartDate, getState, getTemplateFileName, getTemplateFileName, getTemplateFileName, getTemplateFileName, getType, getUrl, instantiateEntity, isCatalogEntryInStore, setAvailabilityDate, setBaseItemId, setBaseItemId, setBuyable, setBuyable, setDiscontinueDate, setEndDate, setEndOfServiceDate, setField1, setField1, setField2, setField2, setField3, setField3, setField4, setField5, setInitKey_catalogEntryReferenceNumber, setInitKey_catalogEntryReferenceNumber, setItemspc_id, setItemspc_id, setLanguage_id, setLanguage_id, setLastOrderDate, setLastUpdate, setLastUpdate, setManufacturerName, setManufacturerPartNumber, setMarkForDelete, setMarkForDelete, setMemberId, setMemberId, setOid, setOnAuction, setOnAuction, setOnSpecial, setOnSpecial, setPartNumber, setStartDate, setState, setUrl
public static final java.lang.String COPYRIGHT
public PackageDataBean()
PackageDataBean
.public PackageDataBean(CatalogEntryAccessBean abCatentry)
PackageDataBean
from a CatalogEntryAccessBean
.abCatentry
- The CatalogEntryAccessBean
.public PackageDataBean(CatalogEntryAccessBean abCatEntry, CommandContext aCommandContext)
PackageDataBean
from a CatalogEntryAccessBean
and a command context.abCatEntry
- The CatalogEntryAccessBean
.aCommandContext
- The command context as CommandContext
object.public AttributeAccessBean[] getAttributes()
AttributeAccessBean
.public AttachmentDataBean[] getAllAttachments()
AttachmentDataBean
public AttachmentDataBean[] getAttachmentsByUsage()
AttachmentDataBean
public AttachmentUsageDataBean[] getAttachmentUsages()
AttachmentUsageDataBean
public AttributeAccessBean[] getDescriptiveAttributes()
AttributeAccessBean
.public java.lang.Long[] getApplicableContractIds() throws ECException
getApplicableContractIds
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
ECException
- An exception occurs during the execution of the method. An exception occurs during the execution of the method.public PriceDataBean[] getApplicableContractPrices()
getApplicableContractPrices
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
PriceDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedBundleDataBean[] getBundleAccessories() throws ECException
getBundleAccessories
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedBundleDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedBundleDataBean[] getBundleAssociations() throws ECException
istrAssociationType
. Set the variable istrAssociationType
through the
setAssociationType()
method before calling getBundleAssociations
. If
istrAssociationType
is null, all types of merchandising associations will return.
For example, the following code returns a list of beans that are bundle up-sells for this package:
setAssociationType("UPSELL");
RelatedBundleDataBean[] rb = getBundleAssociations();
RelatedBundleDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedBundleDataBean[] getBundleCrossSells() throws ECException
getBundleCrossSells
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedBundleDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedBundleDataBean[] getBundleUpSells() throws ECException
getBundleUpSells
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedBundleDataBean
.ECException
- An exception occurs during the execution of the method.public PriceDataBean getCalculatedContractPrice() throws ECException
PriceDataBean
that represents the the calculated contract price for the package.getCalculatedContractPrice
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
PriceDataBean
.ECException
- An exception occurs during the execution of the method.public PriceDataBean getCalculatedPrice() throws ECException
getCalculatedPrice
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
PriceDataBean
.ECException
- An exception occurs during the execution of the method.public CommandContext getCommandContext()
getCommandContext
in interface SmartDataBean
CommandContext
object.public CatalogEntryDescriptionAccessBean getDescription()
getDescription
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
getDescription
in class PackageAccessBean
CatalogEntryDescriptionAccessBean
.public CategorizedMonetaryAmountsDataBean getDisplayTaxes() throws ECException
getTaxes
method in PriceDataBean
to calculate the taxes for those
tax categories that are displayable at product display time.getDisplayTaxes
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
CategorizedMonetaryAmountsDataBean
containing the
taxing monetary amounts, names and descriptions.ECException
- An exception occurs during the execution of the method.public RelatedDynamicKitDataBean[] getDynamicKitAccessories() throws ECException
RelatedDynamicKitDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedDynamicKitDataBean[] getDynamicKitAssociations() throws ECException
istrAssociationType
. Set the variable istrAssociationType
through the
setAssociationType()
method before calling getDynamicKitAssociations
. If
istrAssociationType
is null, all types of merchandising associations will return.
For example, the following code returns a list of beans that are dynamic kit up-sells for this package:
setAssociationType("UPSELL");
RelatedDynamicKitDataBean[] rb = getDynamicKitAssociations();
RelatedDynamicKitDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedDynamicKitDataBean[] getDynamicKitCrossSells() throws ECException
RelatedDynamicKitDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedDynamicKitDataBean[] getDynamicKitUpSells() throws ECException
RelatedDynamicKitDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemAccessories() throws ECException
getItemAccessories
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedItemDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemAssociations() throws ECException
istrAssociationType
. Set the variable istrAssociationType
through the
setAssociationType()
method before calling getItemAssociations
. If
istrAssociationType
is null, all types of merchandising associations will return.
For example, the following code returns a list of beans that are item up-sells for this package:
setAssociationType("UPSELL");
RelatedItemDataBean[] ri = getItemAssociations();
RelatedItemDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemCrossSells() throws ECException
getItemCrossSells
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedItemDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemUpSells() throws ECException
getItemUpSells
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedItemDataBean
.ECException
- An exception occurs during the execution of the method.public PriceDataBean getListPrice() throws ECException
getListPrice
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
PriceDataBean
.ECException
- Any ECException capturedpublic java.lang.String getObjectPath() throws ECException
ECException
- An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageAccessories() throws ECException
getPackageAccessories
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageAssociations() throws ECException
istrAssociationType
. Set the variable istrAssociationType
through the
setAssociationType()
method before calling getPackageAssociations
. If
istrAssociationType
is null, all types of merchandising associations will return.
For example, the following code returns a list of beans that are package up-sells for this package:
setAssociationType("UPSELL");
RelatedPackageDataBean[] rp = getPackageAssociations();
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageCrossSells() throws ECException
getPackageCrossSells
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public CompositeItemDataBean[] getPackagedItems() throws ECException
getPackagedItems
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
CompositeItemDataBean
.ECException
- An exception occurs during the execution of the method.public CompositeProductDataBean[] getPackagedProducts() throws ECException
getPackagedProducts
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
CompositeProductDataBean
.ECException
- An exception occurs during the execution of the method.public CompositePackageDataBean[] getPackagedPackages() throws ECException
CompositePackageDataBean
.ECException
- An exception occurs during the execution of the method.public java.lang.String getPackageID()
getPackageID
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
public java.lang.String getPackagePartNumber()
public RelatedPackageDataBean[] getPackageUpSells() throws ECException
getPackageUpSells
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedProductDataBean[] getProductAccessories() throws ECException
getProductAccessories
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedProductDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedProductDataBean[] getProductAssociations() throws ECException
istrAssociationType
. Set the variable istrAssociationType
through the
setAssociationType()
method before calling getProductAssociations
. If
istrAssociationType
is null, all types of merchandising associations will return.
For example, the following code returns a list of beans that are product up-sells for this package:
setAssociationType("UPSELL");
RelatedProductDataBean[] rp = getProductAssociations();
RelatedProductDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedProductDataBean[] getProductCrossSells() throws ECException
getProductCrossSells
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedProductDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedProductDataBean[] getProductUpSells() throws ECException
getProductUpSells
in interface com.ibm.commerce.catalog.beans.PackageSmartDataBean
RelatedProductDataBean
ECException
- An exception occurs during the execution of the method.public TypedProperty getRequestProperties()
getRequestProperties
in interface InputDataBean
TypedProperty
object.public void populate()
populate
in interface SmartDataBean
java.lang.Exception
- An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageReplacements() throws ECException
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public void setCommandContext(CommandContext aCommandContext)
setCommandContext
in interface SmartDataBean
aCommandContext
- The command context as CommandContext
object.public void setDescription(CatalogEntryDescriptionAccessBean aabDescription)
aabDescription
- The description to be set as a CatalogEntryDescriptionAccessBean
object.public void setPackageID(java.lang.String astrPackageId)
astrPackageId
- The package ID.public void setAssociationType(java.lang.String type)
istrAssociationType
, which represents the target association type to be processed by
an internal method called processCatalogEntryAssociation()
. Call this method before the following methods to
retrieve a list of specific merchandising association types: getBundleAssociations
,
getDynamicKitAssociations
, getItemAssociations
, getPackageAssociations
,
getProductAssociations
. If type
is null, all types of merchandising associations will return.
type
- The merchandising association type. Valid values are stored in the MASSOCTYPE.MASSOCTYPE_ID column, for example, "X-SELL".public void setAttachmentUsage(java.lang.String astrAttachmentUsage)
astrAttachmentUsage
- The attachment relation usage identifierpublic void setPackagePartNumber(java.lang.String astrPackagePartNumber)
setPackagePartNumber
in interface com.ibm.commerce.catalog.beans.PackageInputDataBean
astrPackagePartNumber
- The part (SKU) number of the package.public void setRequestProperties(TypedProperty aParam)
setRequestProperties
in interface InputDataBean
aParam
- The request property as a TypedProperty
object.public boolean isAdminMode()
false
is the default.true
if the bean is running in administrative mode; false
otherwise.public void setAdminMode(boolean aboolAdminMode)
iboolAdminMode
- true
to have the bean in administrative mode; false
otherwise.public PriceDataBean getStandardPrice()
PriceDataBean
.public AttributeDataBean[] getAttributeDataBeans()
AttributeDataBean
.public AttributeDataBean[] getDescriptiveAttributeDataBeans()
AttributeDataBean
.public boolean isMerchandisingAssociated()
public boolean isAnyMerchandisingAssociated()
public boolean isCalculatedContractPriced()
public boolean isListPriced()
public int getNumberOfApplicableContractIds() throws ECException
ECException
- An exception occurs during the execution of the method. An exception occurs during the execution of the method.public boolean isCheckNumberOfApplicableContractIds()
public ContractDataBean[] getApplicableContracts()
ContractDataBean[]
.public com.ibm.commerce.catalog.util.RangePricingData[] getApplicableContractPriceRanges() throws ECException
RangePricingData
that contains the tiered pricing data for
each of the contracts applicable to this package.ECException
- An exception occurs during the execution of the method.