Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• CollateralSearchListDataBean

  public CollateralSearchListDataBean()
  

  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 collaterals.

  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.

• getCollateralList

  public CollateralSearchDataBean[] getCollateralList()
  

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

  Returns:

  The list of collateral data beans.

• getCollateralListData

  public CollateralSearchDataBean getCollateralListData(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 CollateralSearchDataBean 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 CollateralSearchDataBean object.

  Throws:

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

• getCollateralName

  public java.lang.String getCollateralName()
  

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

  Returns:

  The collateral name in the name criteria.

• getCollateralNameType

  public java.lang.String getCollateralNameType()
  

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

  Returns:

  The type of search on the collateral name criteria.

• setCollateralList

  public void setCollateralList(java.util.Vector newCollateralList)
  

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

  Parameters:

  newCollateralList - The list of collateral data beans.

• setCollateralName

  public void setCollateralName(java.lang.String newCollateralName)
  

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

  Parameters:

  newCollateralName - The collateral name in the name criteria.

• setCollateralNameType

  public void setCollateralNameType(java.lang.String newCollateralNameType)
  

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

  Parameters:

  newCollateralNameType - The type of search on the collateral name criteria.