com.ibm.commerce.catalog.beans

Class DynamicKitDataBean

  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, com.ibm.commerce.catalog.beans.DynamicKitInputDataBean, com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean, java.io.Serializable


    public class DynamicKitDataBean
    extends DynamicKitAccessBean
    implements com.ibm.commerce.catalog.beans.DynamicKitInputDataBean, com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
    This data bean represents a Dynamic Kit.

    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):

    • dynamic kit ID

    Some hints and tips for using this data bean are:

    • It is important to set the dynamic kit ID value before activating the data bean
    • You can set parameters using the constructor, or the setters

    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The internal copyright field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • DynamicKitDataBean

        public DynamicKitDataBean()
        Constructs an empty DynamicKitDataBean.
      • DynamicKitDataBean

        public DynamicKitDataBean(CatalogEntryAccessBean abCatentry)
        Constructs a DynamicKitDataBean 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.
      • DynamicKitDataBean

        public DynamicKitDataBean(CatalogEntryAccessBean abCatEntry,
                                  CommandContext aCommandContext)
        Constructs a DynamicKitDataBean 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

      • getAllAttachments

        public AttachmentDataBean[] getAllAttachments()
        Gets all the attachments in the dynamic kit.
        Returns:
        An array of AttachmentDataBean
      • getAttachmentsByUsage

        public AttachmentDataBean[] getAttachmentsByUsage()
        Get all the dynamic kit attachments by the specified attachment relation usage. If there are no attachments to return this method will return a zero length array.
        Returns:
        An array of AttachmentDataBean
      • getAttachmentUsages

        public 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.
        Returns:
        An array of AttachmentUsageDataBean
      • getAttributes

        public AttributeAccessBean[] getAttributes()
        Gets a list of beans that represent attributes of the dynamic kit.
        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()
        Gets a list of beans that represent descriptive attributes of the dynamic kit.
        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.
      • getBundleAccessories

        public RelatedBundleDataBean[] getBundleAccessories()
                                                     throws ECException
        Gets a list of beans that represent bundles that are accessories to this dynamic kit.
        Specified by:
        getBundleAccessories in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Returns:
        The list of RelatedBundleDataBean.
        Throws:
        ECException - An exception occurs during the execution of the method. An exception occurs during the execution of the method.
      • getBundleAssociations

        public RelatedBundleDataBean[] getBundleAssociations()
                                                      throws ECException
        Gets a list of beans that represent bundles that are merchandising associations for this dynamic kit. You can fetch specific types of merchandising associations based on the value of the variable 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();

        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 dynamic kit.
        Specified by:
        getBundleCrossSells in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        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 dynamic kit.
        Specified by:
        getBundleUpSells in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Returns:
        The list of RelatedBundleDataBean.
        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.
        Specified by:
        getCommandContext in interface SmartDataBean
        Returns:
        The command context as CommandContext object.
      • getComponentItems

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

        public CatalogEntryDescriptionAccessBean getDescription()
        Gets a bean representing descriptive information about this dynamic kit.
        Specified by:
        getDescription in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Overrides:
        getDescription in class DynamicKitAccessBean
        Returns:
        The list of 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.
      • getDynamicKitID

        public java.lang.String getDynamicKitID()
        Gets the dynamic kit ID that represents the primary key for this dynamic kit.
        Specified by:
        getDynamicKitID in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Returns:
        The dynamic kit ID.
      • getItemAccessories

        public RelatedItemDataBean[] getItemAccessories()
                                                 throws ECException
        Gets a list of beans that represent items that are accessories to this dynamic kit.
        Specified by:
        getItemAccessories in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Returns:
        The list of RelatedItemDataBean.
        Throws:
        ECException - An exception occurs during the execution of the method.
      • getItemAssociations

        public RelatedItemDataBean[] getItemAssociations()
                                                  throws ECException
        Gets a list of beans that represent items that are merchandising associations for this dynamic kit. You can fetch specific types of merchandising associations based on the value of the variable 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();

        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 dynamic kit.
        Specified by:
        getItemCrossSells in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        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 dynamic kit.
        Specified by:
        getItemUpSells in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Returns:
        The list of RelatedItemDataBean.
        Throws:
        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 dynamic kit.
        Specified by:
        getPackageAccessories in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        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 dynamic kit.
        Specified by:
        getPackageCrossSells in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Returns:
        The list of RelatedPackageDataBean.
        Throws:
        ECException - An exception occurs during the execution of the method.
      • getPackageAssociations

        public RelatedPackageDataBean[] getPackageAssociations()
                                                        throws ECException
        Gets a list of beans that represent packages that are merchandising associations for this dynamic kit. You can fetch specific types of merchandising associations based on the value of the variable 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();

        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 dynamic kit.
        Specified by:
        getPackageUpSells in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        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 dynamic kit.
        Specified by:
        getPartNumber in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Overrides:
        getPartNumber in class DynamicKitAccessBean
        Returns:
        The part (SKU) number of the dynamic kit.
      • getProductAccessories

        public RelatedProductDataBean[] getProductAccessories()
                                                       throws ECException
        Gets a list of beans that represent products that are accessories to this dynamic kit.
        Specified by:
        getProductAccessories in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Returns:
        The RelatedProductDataBean.
        Throws:
        ECException - An exception occurs during the execution of the method.
      • getProductAssociations

        public RelatedProductDataBean[] getProductAssociations()
                                                        throws ECException
        Gets a list of beans that represent products that are merchandising associations for this dynamic kit. You can fetch specific types of merchandising associations based on the value of the variable 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();

        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 dynamic kit.
        Specified by:
        getProductCrossSells in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        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 dynamic kit.
        Specified by:
        getProductUpSells in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Returns:
        The list of RelatedProductDataBean.
        Throws:
        ECException - An exception occurs during the execution of the method.
      • getRequestProperties

        public TypedProperty getRequestProperties()
        Gets the request property.
        Specified by:
        getRequestProperties in interface InputDataBean
        Returns:
        The request property as TypedProperty object. Always returned null.
      • populate

        public void populate()
        Loads data into the data bean when the DataBeanManager.activate() runs.
        Specified by:
        populate in interface SmartDataBean
        Throws:
        java.lang.Exception - 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 to this dynamic kit.
        Returns:
        The list of RelatedDynamicKitDataBean.
        Throws:
        ECException - An exception occurs during the execution of the method.
      • getDynamicKitAssociations

        public RelatedDynamicKitDataBean[] getDynamicKitAssociations()
                                                              throws ECException
        Gets a list of beans that represent dynamic kits that are merchandising associations for this dynamic kit. You can fetch specific types of merchandising associations based on the value of the variable 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();

        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 to this dynamic kit.
        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 to this dynamic kit.
        Returns:
        The list of RelatedDynamicKitDataBean.
        Throws:
        ECException - An exception occurs during the execution of the method.
      • getDynamicKitReplacements

        public RelatedDynamicKitDataBean[] getDynamicKitReplacements()
                                                              throws ECException
        Gets a list of beans that represent dynamic kits that are replacements to this dynamic kit.
        Returns:
        The list of RelatedDynamicKitDataBean.
        Throws:
        ECException - An exception occurs during the execution of the method.
      • isAnyMerchandisingAssociated

        public boolean isAnyMerchandisingAssociated()
        Determines whether there are any OOB or custom merchandising associations associated with this catalog entry
        Returns:
        true if there are merchandising associations associated with this catalog entry, false otherwise.
      • getComponentKits

        public DynamicKitDataBean[] getComponentKits()
                                              throws ECException
        This is reserved for IBM internal use.
        Returns:
        The list of CompositeItemDataBean.
        Throws:
        ECException - An exception occurs during the execution of the method.
      • setCommandContext

        public void setCommandContext(CommandContext aCommandContext)
        Sets the command context passed in at run time.
        Specified by:
        setCommandContext in interface SmartDataBean
        Parameters:
        aCommandContext - The command context as CommandContext object.
      • setDescription

        public void setDescription(CatalogEntryDescriptionAccessBean aabDescription)
        Sets the descriptive information about this dynamic kit.
        Parameters:
        aabDescription - The CatalogEntryDescriptionAccessBean.
      • setAssociationType

        public 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(). 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.
        Avoid calling this method multiple times. If this method is called multiple times, even with the same parameters, the same internal method will also be called multiple times, and may result in performance degradation.
        Parameters:
        type - The merchandising association type. Valid values are stored in the MASSOCTYPE.MASSOCTYPE_ID column, for example, "X-SELL".
      • setDynamicKitID

        public void setDynamicKitID(java.lang.String astrDynamicKitId)
        Sets the ID that represents the primary key for this DynamicKit.
        Specified by:
        setDynamicKitID in interface com.ibm.commerce.catalog.beans.DynamicKitInputDataBean
        Parameters:
        astrItemId - The dynamic kit ID.
      • setPartNumber

        public void setPartNumber(java.lang.String astrDynamicKitPartNumber)
        Sets the DynamicKit part (SKU) number.
        Specified by:
        setPartNumber in interface com.ibm.commerce.catalog.beans.DynamicKitInputDataBean
        Overrides:
        setPartNumber in class DynamicKitAccessBean
        Parameters:
        astrItemPartNumber - The dynamic kit part number.
      • setAttachmentUsage

        public 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.
        Parameters:
        astrAttachmentUsage - The attachment relation usage identifier
      • setRequestProperties

        public void setRequestProperties(TypedProperty aParam)
        Sets the request properties and populates the parameters that are needed by the bean. The following values are set in this method: dynamic kit ID
        Specified by:
        setRequestProperties in interface InputDataBean
        Parameters:
        aParam - The request property as TypedProperty object.
      • isAdminMode

        public boolean isAdminMode()
        Gets if the bean is running in administrative mode. The default is false.
        Returns:
        true if the bean is used in administrative mode ; false otherwise.
      • setAdminMode

        public void setAdminMode(boolean aboolAdminMode)
        Sets the administrative mode of the bean.
        Parameters:
        iboolAdminMode - true to run the bean in administrative mode; false for normal mode.
      • getEntitledComponents

        public CompositeCatalogEntryDataBean[] getEntitledComponents()
                                                              throws ECException
        Gets a list of beans that represent items that are entitled to be seen by the user who is browsing this product.
        Specified by:
        getEntitledComponents in interface com.ibm.commerce.catalog.beans.DynamicKitSmartDataBean
        Returns:
        The list of ItemDataBean.
        Throws:
        ECException - An exception occurs during the execution of the method.
      • getAttributeDataBeans

        public AttributeDataBean[] getAttributeDataBeans()
        Gets a list of data beans that represent attributes of the product. If there are no attributes to return this method will return a zero length array.
        Returns:
        The list of AttributeDataBean.
      • getDescriptiveAttributeDataBeans

        public AttributeDataBean[] getDescriptiveAttributeDataBeans()
        Gets a list of data beans that represent descriptive attributes of the product.
        Returns:
        The list of AttributeDataBean.
      • getAllCompleteDynamicKitPredefinedConfigurationDataBeansInSequenceOrder

        public DynamicKitPredefinedConfigurationDataBean[] getAllCompleteDynamicKitPredefinedConfigurationDataBeansInSequenceOrder()
        Gets an array of data beans ordered by sequence that represent the available complete predefined configurations for this dynamic kit.
        Returns:
        The array of DynamicKitPredefinedConfigurationDataBean beans.
      • getAllDynamicKitPredefinedConfigurationDataBeansInSequenceOrder

        public DynamicKitPredefinedConfigurationDataBean[] getAllDynamicKitPredefinedConfigurationDataBeansInSequenceOrder()
        Gets an array of data beans ordered by sequence that represent the available predefined configurations for this dynamic kit.
        Returns:
        The array of DynamicKitPredefinedConfigurationDataBean beans.
      • getAllIncompleteDynamicKitPredefinedConfigurationDataBeansInSequenceOrder

        public DynamicKitPredefinedConfigurationDataBean[] getAllIncompleteDynamicKitPredefinedConfigurationDataBeansInSequenceOrder()
        Gets an array of data beans ordered by sequence that represent the available predefined configurations for this dynamic kit.
        Returns:
        The array of DynamicKitPredefinedConfigurationDataBean beans.
      • getApplicableContractIds

        public java.lang.Long[] getApplicableContractIds()
                                                  throws ECException
        Gets a list of applicable contracts for this dynamic kit and shopper.
        Returns:
        The list of contract IDs.
        Throws:
        ECException - An exception occurs during the execution of the method.