com.ibm.commerce.tools.campaigns

Class CampaignCollateralDataBean

  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, com.ibm.commerce.security.Delegator, com.ibm.commerce.security.Protectable, CampaignConstants, java.io.Serializable


    public class CampaignCollateralDataBean
    extends CampaignCollateralDataBeanBase
    implements CampaignConstants
    This class extends the SmartDataBeanImpl class to create a data bean for an ad copy.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • URL_TYPE_COMMAND

        public static final java.lang.String URL_TYPE_COMMAND
        Static text used to represent that the URL makes use of the WebSphere Commerce command.
        See Also:
        Constant Field Values
      • URL_TYPE_CUSTOM

        public static final java.lang.String URL_TYPE_CUSTOM
        Static text used to represent that the URL is custom built.
        See Also:
        Constant Field Values
      • URL_TYPE_NONE

        public static final java.lang.String URL_TYPE_NONE
        Static text used to represent that the URL of this ad copy is not required.
        See Also:
        Constant Field Values
    • Constructor Detail

      • CampaignCollateralDataBean

        public CampaignCollateralDataBean()
    • Method Detail

      • getCollateralName

        public java.lang.String getCollateralName()
        Gets the collateral name.
        Returns:
        The name of the collateral.
      • getCollateralType

        public java.lang.Integer getCollateralType()
        Gets the collateral image type.
        Returns:
        The image type of the collateral.
      • getDescriptionField1

        public java.lang.String getDescriptionField1()
        Gets the collateral description field 1.
        Returns:
        The description field 1 of the collateral.
      • getDescriptionField2

        public java.lang.String getDescriptionField2()
        Gets the collateral description field 2.
        Returns:
        The description field 2 of the collateral.
      • getField1

        public java.lang.String getField1()
        Gets the collateral custom field 1.
        Returns:
        The custom field 1 of the collateral.
      • getField2

        public java.lang.String getField2()
        Gets the collateral custom field 2.
        Returns:
        The custom field 2 of the collateral.
      • getId

        public java.lang.Integer getId()
        Gets the collateral ID.
        Returns:
        The ID of the collateral.
      • getLocations

        public java.lang.String getLocations()
        Gets the collateral image file location.
        Returns:
        The file location of the collateral.
      • getMarketingText

        public java.lang.String getMarketingText()
        Gets the collateral marketing text.
        Returns:
        The marketing text of the collateral.
      • getStoreId

        public java.lang.Integer getStoreId()
        Gets the ID of the store which this collateral belongs to.
        Returns:
        The ID of the store which this collateral belongs to.
      • getTargetId

        public java.lang.String getTargetId()
        Gets target id
        Returns:
      • getTypeName

        public java.lang.String getTypeName()
        Gets the collateral image type name.
        Returns:
        The image type name of the collateral.
      • getTypeSelection

        public java.util.Vector getTypeSelection()
        Gets all collateral types available in the user interface.
        Returns:
        All collateral types available in the user interface.
      • getUrl

        public java.lang.String getUrl()
        Gets the collateral URL.
        Returns:
        The URL of the collateral.
      • getUrlCommand

        public java.lang.String getUrlCommand()
        Gets the collateral URL, this should only be used for command URL.
        Returns:
        The collateral URL using a command.
      • getUrlCommandParameter

        public java.lang.String getUrlCommandParameter()
        Gets the collateral parameter, which is the product, category, promotion or coupon name of the command URL parameter.
        Returns:
        The name of the collateral command URL parameter.
      • getUrlCommandType

        public java.lang.String getUrlCommandType()
        Gets the WebSphere Commerce command used by collateral URL.
        Returns:
        The WebSphere Commerce command used by collateral URL.
      • getUrlCustom

        public java.lang.String getUrlCustom()
        Gets the collateral URL, this should only be used for custom URL.
        Returns:
        The custom collateral URL.
      • getUrlType

        public java.lang.String getUrlType()
        Gets the collateral URL type, either URL using WebSphere Commerce command or custom URL.
        Returns:
        The URL type of the collateral.
      • populate

        public void populate()
                      throws java.lang.Exception
        Populate the data bean that includes all the data related to this collateral.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class com.ibm.commerce.beans.SmartDataBeanImpl
        Throws:
        java.lang.Exception - Thrown whenever an exception is encountered.
      • setId

        public void setId(java.lang.Integer id)
        Sets the collateral ID.
        Parameters:
        id - The collateral ID.
      • setTargetId

        public void setTargetId(java.lang.String tgtId)
        Sets target id
        Parameters:
        long1 -
      • setXML

        public void setXML(java.util.Hashtable xml)
        Sets the XML.
        Parameters:
        xml - The XML that describes this collateral.