com.ibm.commerce.tools.campaigns

Class CampaignListDataBean

  • 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 CampaignListDataBean
    extends CampaignListDataBeanBase
    implements CampaignConstants
    This class extends the SmartDataBeanImpl class to create the campaign list data bean.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

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

      • CampaignListDataBean

        public CampaignListDataBean()
    • Method Detail

      • getCampaignList

        public CampaignDataBean[] getCampaignList()
        Gets an array of CampaignDataBean objects.
        Returns:
        An array of CampaignDataBean objects.
      • getLocalSearch

        public boolean getLocalSearch()
        Gets the value of the local search flag.
        Returns:
        True if search on current store only; false otherwise.
      • populate

        public void populate()
                      throws java.lang.Exception
        Populates the data bean that includes all the campaigns found.
        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.
      • setLocalSearch

        public void setLocalSearch(boolean newLocalSearch)
        Sets the local search flag, a true value will instruct the data bean to search for campaigns in the current store only; a false value will instruct the data bean to go up the store path and find all campaigns owned by stores on the store path.
        Parameters:
        newLocalSearch - True if search on current store only; false otherwise.