com.ibm.commerce.tools.campaigns

Class CampaignSimpleListDataBean

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.tools.campaigns.CampaignSimpleListDataBean
  • 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, java.io.Serializable


    public class CampaignSimpleListDataBean
    extends com.ibm.commerce.beans.SmartDataBeanImpl
    implements com.ibm.commerce.security.Protectable, com.ibm.commerce.security.Delegator
    This class returns a list of campaigns associated with a store. This class has improved performance over CampaignListDataBean as this class only returns the campaign IDs and the campaign names. This is used when associating a web activity to a campaign. You can specify to return the campaigns for all stores on the store path, or only the ones from the current store.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String[] getCampaignIdList()
      This method returns the list of campaign IDs for the campaigns in a store.
      java.lang.String[] getCampaignNameList()
      This method returns the list of campaign names for the campaigns in a store.
      com.ibm.commerce.security.Protectable getDelegate()
      This method returns the access control delegate of this data bean.
      boolean getLocalSearch()
      This method gets the value of the local search flag.
      java.lang.Long getOwner()
      This method gets the owner of the campaigns.
      void populate()
      This method searches the database for the campaigns in a store, and sets the data to be returned by the getCampaignIdList and getCampaignNameList methods.
      void setLocalSearch(boolean newLocalSearch)
      This method sets the local search flag.
      • Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

        fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
      • Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

        getRequestProperties, setRequestProperties
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.security.Protectable

        fulfills
      • Methods inherited from interface com.ibm.commerce.beans.InputDataBean

        getRequestProperties, setRequestProperties
    • Field Detail

      • COPYRIGHT

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

      • CampaignSimpleListDataBean

        public CampaignSimpleListDataBean()
        Constructs an CampaignSimpleListDataBean
    • Method Detail

      • getCampaignIdList

        public java.lang.String[] getCampaignIdList()
        This method returns the list of campaign IDs for the campaigns in a store. The method getCampaignNameList will be an array of the same size with the corresponding names of the campaigns.
        Returns:
        This method returns an array of Strings with campaign IDs. If there are no campaigns, then the size of the list will be zero.
      • getCampaignNameList

        public java.lang.String[] getCampaignNameList()
        This method returns the list of campaign names for the campaigns in a store. The method getCampaignIdList will be an array of the same size with the corresponding IDs of the campaigns.
        Returns:
        This method returns an array of Strings with campaign names. If there are no campaigns, then the size of the list will be zero.
      • getDelegate

        public com.ibm.commerce.security.Protectable getDelegate()
                                                          throws java.lang.Exception
        This method returns the access control delegate of this data bean.
        Specified by:
        getDelegate in interface com.ibm.commerce.security.Delegator
        Returns:
        This method return the current class.
        Throws:
        java.lang.Exception
      • getLocalSearch

        public boolean getLocalSearch()
        This method gets the value of the local search flag.
        Returns:
        This method returns true if only campaigns from the current store should be returned.
      • getOwner

        public java.lang.Long getOwner()
                                throws java.lang.Exception
        This method gets the owner of the campaigns. It returns the owner of the current store.
        Specified by:
        getOwner in interface com.ibm.commerce.security.Protectable
        Returns:
        This method returns the member ID of the owner of the current store.
        Throws:
        java.lang.Exception - raised when there is a remote exception
      • populate

        public void populate()
                      throws java.lang.Exception
        This method searches the database for the campaigns in a store, and sets the data to be returned by the getCampaignIdList and getCampaignNameList methods.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class com.ibm.commerce.beans.SmartDataBeanImpl
        Throws:
        java.lang.Exception
      • setLocalSearch

        public void setLocalSearch(boolean newLocalSearch)
        This method sets the local search flag. A value of true will instruct the data bean to return campaigns in the current store only. A value of false will instruct the data bean to return campaigns owned by all stores on the campaigns store path.
        Parameters:
        newLocalSearch - Set true to return from the current store only.