public class DynamicKitDataBean extends DynamicKitAccessBean implements com.ibm.commerce.catalog.beans.DynamicKitInputDataBean, com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
You can find more information about data beans in the WebSphere Commerce data beans topic in the Information Center.
Access Beans: DynamicKit
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 |
---|
DynamicKitDataBean()
Constructs an empty
DynamicKitDataBean . |
DynamicKitDataBean(CatalogEntryAccessBean abCatentry)
Constructs a
DynamicKitDataBean from a CatalogEntryAccessBean . |
DynamicKitDataBean(CatalogEntryAccessBean abCatEntry,
CommandContext aCommandContext)
Constructs a
DynamicKitDataBean from a CatalogEntryAccessBean and a command context. |
Modifier and Type | Method and Description |
---|---|
AttachmentDataBean[] |
getAllAttachments()
Gets all the attachments in the dynamic kit.
|
DynamicKitPredefinedConfigurationDataBean[] |
getAllCompleteDynamicKitPredefinedConfigurationDataBeansInSequenceOrder()
Gets an array of data beans ordered by sequence that represent the available complete predefined configurations for this dynamic kit.
|
DynamicKitPredefinedConfigurationDataBean[] |
getAllDynamicKitPredefinedConfigurationDataBeansInSequenceOrder()
Gets an array of data beans ordered by sequence that represent the available predefined configurations for this dynamic kit.
|
DynamicKitPredefinedConfigurationDataBean[] |
getAllIncompleteDynamicKitPredefinedConfigurationDataBeansInSequenceOrder()
Gets an array of data beans ordered by sequence that represent the available predefined configurations for this dynamic kit.
|
java.lang.Long[] |
getApplicableContractIds()
Gets a list of applicable contracts for this dynamic kit and shopper.
|
AttachmentDataBean[] |
getAttachmentsByUsage()
Get all the dynamic kit attachments by the specified attachment relation usage.
|
AttachmentUsageDataBean[] |
getAttachmentUsages()
Get all the attachment relation usage used in the dynamic kit attachments
If there are no attachment usages to return this method it will return a zero length array.
|
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 dynamic kit.
|
RelatedBundleDataBean[] |
getBundleAccessories()
Gets a list of beans that represent bundles that are accessories to this dynamic kit.
|
RelatedBundleDataBean[] |
getBundleAssociations()
Gets a list of beans that represent bundles that are merchandising associations for this dynamic kit.
|
RelatedBundleDataBean[] |
getBundleCrossSells()
Gets a list of beans that represent bundles that are cross-sells to this dynamic kit.
|
RelatedBundleDataBean[] |
getBundleUpSells()
Gets a list of beans that represent bundles that are up-sells to this dynamic kit.
|
CommandContext |
getCommandContext()
Gets the current command's context passed in at run time.
|
CompositeItemDataBean[] |
getComponentItems()
Gets a list of beans that represent items that are components of this dynamic kit.
|
DynamicKitDataBean[] |
getComponentKits()
This is reserved for IBM internal use.
|
CatalogEntryDescriptionAccessBean |
getDescription()
Gets a bean representing descriptive information about this dynamic kit.
|
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 dynamic kit.
|
RelatedDynamicKitDataBean[] |
getDynamicKitAccessories()
Gets a list of beans that represent dynamic kits that are accessories to this dynamic kit.
|
RelatedDynamicKitDataBean[] |
getDynamicKitAssociations()
Gets a list of beans that represent dynamic kits that are merchandising associations for this dynamic kit.
|
RelatedDynamicKitDataBean[] |
getDynamicKitCrossSells()
Gets a list of beans that represent dynamic kits that are cross sells to this dynamic kit.
|
java.lang.String |
getDynamicKitID()
Gets the dynamic kit ID that represents the primary key for this dynamic kit.
|
RelatedDynamicKitDataBean[] |
getDynamicKitReplacements()
Gets a list of beans that represent dynamic kits that are replacements to this dynamic kit.
|
RelatedDynamicKitDataBean[] |
getDynamicKitUpSells()
Gets a list of beans that represent dynamic kits that are up sells to this dynamic kit.
|
CompositeCatalogEntryDataBean[] |
getEntitledComponents()
Gets a list of beans that represent items that are entitled to be seen by the user who is browsing this product.
|
RelatedItemDataBean[] |
getItemAccessories()
Gets a list of beans that represent items that are accessories to this dynamic kit.
|
RelatedItemDataBean[] |
getItemAssociations()
Gets a list of beans that represent items that are merchandising associations for this dynamic kit.
|
RelatedItemDataBean[] |
getItemCrossSells()
Gets a list of beans that represent items that are cross-sells to this dynamic kit.
|
RelatedItemDataBean[] |
getItemUpSells()
Gets a list of beans that represent items that are up-sells to this dynamic kit.
|
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 dynamic kit.
|
RelatedPackageDataBean[] |
getPackageAssociations()
Gets a list of beans that represent packages that are merchandising associations for this dynamic kit.
|
RelatedPackageDataBean[] |
getPackageCrossSells()
Gets a list of beans that represent packages that are cross-sells to this dynamic kit.
|
RelatedPackageDataBean[] |
getPackageUpSells()
Gets a list of beans that represent packages that are up-sells to this dynamic kit.
|
java.lang.String |
getPartNumber()
Gets the part (SKU) number of the dynamic kit.
|
RelatedProductDataBean[] |
getProductAccessories()
Gets a list of beans that represent products that are accessories to this dynamic kit.
|
RelatedProductDataBean[] |
getProductAssociations()
Gets a list of beans that represent products that are merchandising associations for this dynamic kit.
|
RelatedProductDataBean[] |
getProductCrossSells()
Gets a list of beans that represent products that are cross-sells to this dynamic kit.
|
RelatedProductDataBean[] |
getProductUpSells()
Gets a list of beans that represent products that are up-sells to this dynamic kit.
|
TypedProperty |
getRequestProperties()
Gets the request property.
|
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
|
void |
populate()
Loads data into the data bean when the
DataBeanManager.activate() runs. |
void |
setAdminMode(boolean aboolAdminMode)
Sets the administrative mode 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 dynamic kit with the same usage.
|
void |
setCommandContext(CommandContext aCommandContext)
Sets the command context passed in at run time.
|
void |
setDescription(CatalogEntryDescriptionAccessBean aabDescription)
Sets the descriptive information about this dynamic kit.
|
void |
setDynamicKitID(java.lang.String astrDynamicKitId)
Sets the ID that represents the primary key for this DynamicKit.
|
void |
setPartNumber(java.lang.String astrDynamicKitPartNumber)
Sets the DynamicKit part (SKU) number.
|
void |
setRequestProperties(TypedProperty aParam)
Sets the request properties and populates the parameters that are needed by the bean.
|
findByCatalog, findByCatalogAndGroup, findByCatalogAndGroupAndStore, findByCatalogAndStore, findByChildCatalogEntry, findByChildCatalogEntryAndStore, findByMemberId, findByMemberIdAndSKUNumber, findEntitledCatalogEntryByCatalogAndGroup, findEntitledCatalogEntryByCatalogAndGroupAndStore, findWithPushDownQuery, fulfills, getAllCompletePredefinedConfigurations, getAllCompletePredefinedConfigurationsOrderBySequence, getAllIncompletePredefinedConfigurations, getAllIncompletePredefinedConfigurationsOrderBySequence, getAllPredefinedConfigurations, getAllPredefinedConfigurationsOrderBySequence, 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, getCatalogEntryConfigurationDetail, 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, getParentCatalogEntryIds, 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, setStartDate, setState, setUrl
public static final java.lang.String COPYRIGHT
public DynamicKitDataBean()
DynamicKitDataBean
.public DynamicKitDataBean(CatalogEntryAccessBean abCatentry)
DynamicKitDataBean
from a CatalogEntryAccessBean
.abCatentry
- The CatalogEntryAccessBean
.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.public DynamicKitDataBean(CatalogEntryAccessBean abCatEntry, CommandContext aCommandContext)
DynamicKitDataBean
from a CatalogEntryAccessBean
and a command context.abCatEntry
- The CatalogEntryAccessBean
.aCommandContext
- The command context as CommandContext
object.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.public AttachmentDataBean[] getAllAttachments()
AttachmentDataBean
public AttachmentDataBean[] getAttachmentsByUsage()
AttachmentDataBean
public AttachmentUsageDataBean[] getAttachmentUsages()
AttachmentUsageDataBean
public AttributeAccessBean[] getAttributes()
AttributeAccessBean
.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.public AttributeAccessBean[] getDescriptiveAttributes()
AttributeAccessBean
.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.public RelatedBundleDataBean[] getBundleAccessories() throws ECException
getBundleAccessories
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
RelatedBundleDataBean
.ECException
- An exception occurs during the execution of the method. 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 dynamic kit:
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.DynamicKitSmartDataBean
RelatedBundleDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedBundleDataBean[] getBundleUpSells() throws ECException
getBundleUpSells
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
RelatedBundleDataBean
.ECException
- An exception occurs during the execution of the method.public CommandContext getCommandContext()
getCommandContext
in interface SmartDataBean
CommandContext
object.public CompositeItemDataBean[] getComponentItems() throws ECException
CompositeItemDataBean
.ECException
- An exception occurs during the execution of the method.public CatalogEntryDescriptionAccessBean getDescription()
getDescription
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
getDescription
in class DynamicKitAccessBean
CatalogEntryDescriptionAccessBean
.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.public java.lang.String getDynamicKitID()
getDynamicKitID
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
public RelatedItemDataBean[] getItemAccessories() throws ECException
getItemAccessories
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
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 dynamic kit:
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.DynamicKitSmartDataBean
RelatedItemDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedItemDataBean[] getItemUpSells() throws ECException
getItemUpSells
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
ECException
- An exception occurs during the execution of the method.public 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.DynamicKitSmartDataBean
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageCrossSells() throws ECException
getPackageCrossSells
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
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 dynamic kit:
setAssociationType("UPSELL");
RelatedPackageDataBean[] rp = getPackageAssociations();
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedPackageDataBean[] getPackageUpSells() throws ECException
getPackageUpSells
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
RelatedPackageDataBean
.ECException
- An exception occurs during the execution of the method.public java.lang.String getPartNumber()
getPartNumber
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
getPartNumber
in class DynamicKitAccessBean
public RelatedProductDataBean[] getProductAccessories() throws ECException
getProductAccessories
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
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 dynamic kit:
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.DynamicKitSmartDataBean
RelatedProductDataBean
.ECException
- An exception occurs during the execution of the method.public RelatedProductDataBean[] getProductUpSells() throws ECException
getProductUpSells
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
RelatedProductDataBean
.ECException
- An exception occurs during the execution of the method.public TypedProperty getRequestProperties()
getRequestProperties
in interface InputDataBean
TypedProperty
object. Always returned null
.public void populate()
DataBeanManager.activate()
runs.populate
in interface SmartDataBean
java.lang.Exception
- 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 dynamic kit:
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 RelatedDynamicKitDataBean[] getDynamicKitReplacements() throws ECException
RelatedDynamicKitDataBean
.ECException
- An exception occurs during the execution of the method.public boolean isAnyMerchandisingAssociated()
public DynamicKitDataBean[] getComponentKits() throws ECException
CompositeItemDataBean
.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 CatalogEntryDescriptionAccessBean
.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 setDynamicKitID(java.lang.String astrDynamicKitId)
setDynamicKitID
in interface com.ibm.commerce.catalog.beans.DynamicKitInputDataBean
astrItemId
- The dynamic kit ID.public void setPartNumber(java.lang.String astrDynamicKitPartNumber)
setPartNumber
in interface com.ibm.commerce.catalog.beans.DynamicKitInputDataBean
setPartNumber
in class DynamicKitAccessBean
astrItemPartNumber
- The dynamic kit part number.public void setAttachmentUsage(java.lang.String astrAttachmentUsage)
astrAttachmentUsage
- The attachment relation usage identifierpublic void setRequestProperties(TypedProperty aParam)
setRequestProperties
in interface InputDataBean
aParam
- The request property as TypedProperty
object.public boolean isAdminMode()
false
.true
if the bean is used in administrative mode ; false
otherwise.public void setAdminMode(boolean aboolAdminMode)
iboolAdminMode
- true
to run the bean in administrative mode; false
for normal mode.public CompositeCatalogEntryDataBean[] getEntitledComponents() throws ECException
getEntitledComponents
in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
ItemDataBean
.ECException
- An exception occurs during the execution of the method.public AttributeDataBean[] getAttributeDataBeans()
AttributeDataBean
.public AttributeDataBean[] getDescriptiveAttributeDataBeans()
AttributeDataBean
.public DynamicKitPredefinedConfigurationDataBean[] getAllCompleteDynamicKitPredefinedConfigurationDataBeansInSequenceOrder()
DynamicKitPredefinedConfigurationDataBean
beans.public DynamicKitPredefinedConfigurationDataBean[] getAllDynamicKitPredefinedConfigurationDataBeansInSequenceOrder()
DynamicKitPredefinedConfigurationDataBean
beans.public DynamicKitPredefinedConfigurationDataBean[] getAllIncompleteDynamicKitPredefinedConfigurationDataBeansInSequenceOrder()
DynamicKitPredefinedConfigurationDataBean
beans.public java.lang.Long[] getApplicableContractIds() throws ECException
ECException
- An exception occurs during the execution of the method.