com.ibm.commerce.tools.campaigns

Class CampaignEmsListCursorDataBean

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.tools.util.CommonSearchHelperBean
          • com.ibm.commerce.tools.campaigns.CampaignEmsListCursorDataBean
  • 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 CampaignEmsListCursorDataBean
extends com.ibm.commerce.tools.util.CommonSearchHelperBean
implements com.ibm.commerce.security.Protectable, com.ibm.commerce.security.Delegator
    This class returns a list of e-Marketing Spot CampaignEmsDataBean data beans for e-Marketing spots associated with a store. This class has improved performance over CampaignEmsListDataBean 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 e-Marketing Spots. This class can query both MARKETING and CONTENT type e-Marketing Spots. As well, you can specify to return the e-Marketing Spots 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 buildQuery()
      This method constructs the database query.
      void buildResultDataBean(java.util.Vector resultVector)
      This method constructs the list of CampaignEmsListDataBean data beans based on the results returned from the database.
      com.ibm.commerce.security.Protectable getDelegate()
      This method returns the access control delegate of this data bean.
      CampaignEmsDataBean[] getEmsList()
      This method gets the list of CampaignEmsListDataBean data beans based on the database results.
      java.lang.String getEmsUsageType()
      This method gets the value of the usage type identifier.
      boolean getLocalSearch()
      This method gets the value of the local search flag.
      java.lang.Long getOwner()
      This method gets the owner of the e-Marketing Spots.
      void setEmsList(java.util.Vector newEmsList)
      This method sets the list of CampaignEmsListDataBean data beans based on the database results.
      void setEmsUsageType(java.lang.String newUsageType)
      This method sets the value of the usage type identifier.
      void setLocalSearch(boolean newLocalSearch)
      This method sets the local search flag.

      • 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

      • CampaignEmsListCursorDataBean

        public CampaignEmsListCursorDataBean()
        Constructs an CampaignEmsListCursorDataBean

    • Method Detail

      • buildQuery

        public java.lang.String buildQuery()
                            throws java.lang.Exception
        This method constructs the database query.
        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 CampaignEmsListDataBean 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

      • getEmsList

        public CampaignEmsDataBean[] getEmsList()
        This method gets the list of CampaignEmsListDataBean data beans based on the database results.
        Returns:
        This method return an array of CampaignEmsListDataBean data beans.

      • getEmsUsageType

        public java.lang.String getEmsUsageType()
        This method gets the value of the usage type identifier. Possible values are MARKETING or CONTENT. The database query will look for e-Marketing Spots of this type.
        Returns:
        This method returs the value of the usage type identifier.

      • getLocalSearch

        public boolean getLocalSearch()
        This method gets the value of the local search flag.
        Returns:
        This method returns true if only e-Marketing Spots from the current store should be returned.

      • 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

      • setEmsList

        public void setEmsList(java.util.Vector newEmsList)
        This method sets the list of CampaignEmsListDataBean data beans based on the database results.
        Parameters:
        newEmsList - The list of CampaignEmsListDataBean data beans.

      • setEmsUsageType

        public void setEmsUsageType(java.lang.String newUsageType)
        This method sets the value of the usage type identifier. This value will instruct the data bean to search for e-Marketing Spots or content spots.
        Parameters:
        newUsageType - The value of the usage type identifier. Possible values are MARKETING or CONTENT.

      • setLocalSearch

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