com.ibm.commerce.tools.campaigns

Class CampaignInitiativeListCursorDataBean

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.tools.util.CommonSearchHelperBean
          • com.ibm.commerce.tools.campaigns.CampaignInitiativeListCursorDataBean
  • 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 CampaignInitiativeListCursorDataBean
    extends com.ibm.commerce.tools.util.CommonSearchHelperBean
    implements com.ibm.commerce.security.Protectable, com.ibm.commerce.security.Delegator, CampaignConstants
    This class returns a list of Initiatives CampaignInitiativeDataBean data beans for Initiatives associated with a store. This class has improved performance over CampaignInitiativeListDataBean 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 initiatives.
    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

      • CampaignInitiativeListCursorDataBean

        public CampaignInitiativeListCursorDataBean()
    • Method Detail

      • buildQuery

        public java.lang.String buildQuery()
                                    throws java.lang.Exception
        This method constructs the database query to fetch the Initiative details
        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 CampaignInitiativeDataBean 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.
      • 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
      • getInitiativeList

        public CampaignInitiativeDataBean[] getInitiativeList()
        Gets an array of CampaignInitiativeDataBean objects.
        Returns:
        An array of CampaignInitiativeDataBean objects.
      • 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 initiatives in the current store only; a false value will instruct the data bean to go up the store path and find all initiatives own by stores on the store path.
        Parameters:
        newLocalSearch - True if search on current store only; false otherwise.