com.ibm.commerce.tools.campaigns

Class CampaignListCursorDataBean

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.tools.util.CommonSearchHelperBean
          • com.ibm.commerce.tools.campaigns.CampaignListCursorDataBean
  • 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 CampaignListCursorDataBean
extends com.ibm.commerce.tools.util.CommonSearchHelperBean
implements com.ibm.commerce.security.Protectable, com.ibm.commerce.security.Delegator
    This class returns a list of Campaigns CampaignDataBean data beans for Campaigns associated with a store. This class has improved performance over CampaignListDataBean as this class uses a database cursor to only return the applicable rows from the database (based on the start and end index), instead of having the client only display the applicable rows from the entire list of campaigns.
    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 buildQuery()
      This method constructs the database query to fetch the Campaign Ids.
      void buildResultDataBean(java.util.Vector resultVector)
      This method constructs the list of CampaignDataBean data beans based on the results returned from the database.
      CampaignDataBean[] getCampaignList()
      Gets an array of CampaignDataBean objects.
      com.ibm.commerce.security.Protectable getDelegate()
      This method returns the access control delegate of this data bean.
      boolean getLocalSearch()
      Gets the value of the local search flag.
      java.lang.Long getOwner()
      This method gets the owner of the e-Marketing Spots.
      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.

      • Methods inherited from class com.ibm.commerce.tools.util.CommonSearchHelperBean

        escapeSQLstring, getDefaultLanguageId, getIndexBegin, getIndexEnd, getLanguageId, getListSize, getResultList, getResultSetSize, getStoreId, getStoreIds, getStoreIdsInEntityType, getStoreRelType, getUpperCaseFunction, getUseCursor, populate, setIndexBegin, setIndexEnd, setLanguageId, setResultList, setResultSetSize, setStoreId, setStoreIds, setStoreIdsInEntityType, setStoreRelType, setUseCursor

      • 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

      • CampaignListCursorDataBean

        public CampaignListCursorDataBean()

    • Method Detail

      • buildQuery

        public java.lang.String buildQuery()
                            throws java.lang.Exception
        This method constructs the database query to fetch the Campaign Ids.
        Specified by:
        buildQuery in class com.ibm.commerce.tools.util.CommonSearchHelperBean
        Returns:
        The method returns the SQL query string to be used by the CommonSearchHelperBean class.
        Throws:
        java.lang.Exception

      • buildResultDataBean

        public void buildResultDataBean(java.util.Vector resultVector)
        This method constructs the list of CampaignDataBean data beans based on the results returned from the database.
        Specified by:
        buildResultDataBean in class com.ibm.commerce.tools.util.CommonSearchHelperBean
        Parameters:
        resultVector - The result vector returned from the database query.

      • getCampaignList

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

      • 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()
        Gets the value of the local search flag.
        Returns:
        True if search on current store only; false otherwise.

      • getOwner

        public java.lang.Long getOwner()
                        throws java.lang.Exception
        This method gets the owner of the e-Marketing Spots. 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

      • 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.
Skip navigation links