Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• PromotionSearchListDataBean

  public PromotionSearchListDataBean()
  

  The default constructor for this class.

Method Detail

• buildQuery

  public java.lang.String buildQuery()
                              throws java.lang.Exception
  

  This method constructs the SQL query. Here the query must be put together using the user given parameters for the search to be performed properly. This implements the buildQuery abstract method in com.ibm.commerce.tools.util.CommonSearchHelperBean and be called by the populate method found in the same abstract class.

  Specified by:

  buildQuery in class com.ibm.commerce.tools.util.CommonSearchHelperBean

  Returns:

  The SQL query string that is used to search for promotions.

  Throws:

  java.lang.Exception - Thrown when an exception is encountered when constructing the query.

• buildResultDataBean

  public void buildResultDataBean(java.util.Vector resultVector)
  

  This method constructs the list of result data beans. After the SQL has been performed and a result vector has been returned, a list of data beans will be populated. This is called by the populate method found in the com.ibm.commerce.tools.util.CommonSearchHelperBean.

  Specified by:

  buildResultDataBean in class com.ibm.commerce.tools.util.CommonSearchHelperBean

  Parameters:

  resultVector - The result vector returned from the query execution.

• getPromotionList

  public PromotionSearchDataBean[] getPromotionList()
  

  This method returns the list of data beans found from the search or list, represented by an array of PromotionSearchDataBean object. These are data beans that each hold data about a returned row. Each row returned has its own data bean.

  Returns:

  The list of promotion data beans.

• getPromotionListData

  public PromotionSearchDataBean getPromotionListData(int index)
                                               throws java.lang.ArrayIndexOutOfBoundsException
  

  This method returns the specific data bean at the passed index within the array of data beans returned, represented by the PromotionSearchDataBean object. If the index is larger than the size of the array, an ArrayIndexOutOfBoundsException will be thrown.

  Parameters:

  index - The index of the result array.

  Returns:

  The specific entry that was found in the array of PromotionSearchDataBean object.

  Throws:

  java.lang.ArrayIndexOutOfBoundsException - Thrown when accessing an array with an out of bound index.

• getPromotionName

  public java.lang.String getPromotionName()
  

  This method returns the name of the promotion to be searched for, this is the value of the name criteria.

  Returns:

  The promotion name in the name criteria.

• getPromotionNameType

  public java.lang.String getPromotionNameType()
  

  This method returns the type of search that is being performed to the promotion name criteria.

  Returns:

  The type of search on the promotion name criteria.

• setPromotionList

  public void setPromotionList(java.util.Vector newPromotionList)
  

  This method sets the list of data beans found from the search or list, represented by an array of PromotionSearchDataBean object. These are data beans that each hold data about a returned row. Each row returned has its own data bean.

  Parameters:

  newPromotionList - The list of promotion data beans.

• setPromotionName

  public void setPromotionName(java.lang.String newPromotionName)
  

  This method sets the name of the promotion to be searched for, this is the value of the name criteria.

  Parameters:

  newPromotionName - The promotion name in the name criteria.

• setPromotionNameType

  public void setPromotionNameType(java.lang.String newPromotionNameType)
  

  This method sets the type of search that is being performed to the promotion name criteria.

  Parameters:

  newPromotionNameType - The type of search on the promotion name criteria.