Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• CatalogEntrySearchListDataBean

  public CatalogEntrySearchListDataBean()
  

  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 catalog entries.

  Throws:

  java.lang.Exception - Thrown when an exception is encountered whether 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 executed 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.

• getCatalogEntryList

  public CatalogEntrySearchDataBean[] getCatalogEntryList()
  

  This method returns the list of data beans found from the search or list, represented by an array of CatalogEntrySearchDataBean objects. These are data beans that hold a returned rows data. For each row returned it will have its own data bean.

  Returns:

  The list of catalog entry data beans.

• getCatalogEntryListData

  public CatalogEntrySearchDataBean getCatalogEntryListData(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 CatalogEntrySearchDataBean o bject. 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 CatalogEntrySearchDataBean object.

  Throws:

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

• getCatentryName

  public java.lang.String getCatentryName()
  

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

  Returns:

  The catalog entry name in the name criteria.

• getCatentryNameType

  public java.lang.String getCatentryNameType()
  

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

  Returns:

  Type of search on the catalog entry name criteria.

• getMarkForDelete

  public java.lang.String getMarkForDelete()
  

  This method returns the 'mark for delete' flag that should be used in building the search query.

  Returns:

  The catalog entry 'mark for delete' flag.

• getPartNumber

  public java.lang.String getPartNumber()
  

  This method returns the part number of the catalog entry to be searched for, this is the value of the part number criteria.

  Returns:

  The catalog entry part number in the part number criteria.

• getPartNumberType

  public java.lang.String getPartNumberType()
  

  This method returns the type of search that is being performed to the catalog entry part number criteria.

  Returns:

  Type of search on the catalog entry part number criteria.

• getPublished

  public java.lang.String getPublished()
  

  This method returns the 'published' flag that should be used in building the search query.

  Returns:

  The catalog entry 'published' flag.

• setCatalogEntryList

  public void setCatalogEntryList(java.util.Vector newCatalogEntryList)
  

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

  Parameters:

  newCatalogEntryList - The list of catalog entry data beans.

• setCatentryName

  public void setCatentryName(java.lang.String newCatentryName)
  

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

  Parameters:

  newCatentryName - The catalog entry name in the name criteria.

• setCatentryNameType

  public void setCatentryNameType(java.lang.String newCatentryNameType)
  

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

  Parameters:

  newCatentryNameType - Type of search on the catalog entry name criteria.

• setMarkForDelete

  public void setMarkForDelete(java.lang.String newMarkForDelete)
  

  This method sets the 'mark for delete' flag that should be used in building the search query.

  Parameters:

  newMarkForDelete - The catalog entry 'mark for delete' flag.

• setPartNumber

  public void setPartNumber(java.lang.String newPartNumber)
  

  This method sets the part number of the catalog entry to be searched for, this is the value of the part number criteria.

  Parameters:

  newPartNumber - The catalog entry part number in the part number criteria.

• setPartNumberType

  public void setPartNumberType(java.lang.String newPartNumberType)
  

  This method sets the type of search that is being performed to the catalog entry part number criteria.

  Parameters:

  newPartNumberType - Type of search on the catalog entry part number criteria.

• setPublished

  public void setPublished(java.lang.String newPublished)
  

  This method sets the 'published' flag that should be used in building the search query.

  Parameters:

  newPublished - The catalog entry 'published' flag.