Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• CatalogGroupSearchListDataBean

  public CatalogGroupSearchListDataBean()
  

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

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

• getCatalogGroupList

  public CatalogGroupSearchDataBean[] getCatalogGroupList()
  

  This method returns the list of data beans found from the search or list, represented by an array of CatalogGroupSearchDataBean 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 catalog group data beans.

• getCatalogGroupListData

  public CatalogGroupSearchDataBean getCatalogGroupListData(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 CatalogGroupSearchDataBean 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 CatalogGroupSearchDataBean object.

  Throws:

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

• getCatgroupName

  public java.lang.String getCatgroupName()
  

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

  Returns:

  The catalog group name in the name criteria.

• getCatgroupNameType

  public java.lang.String getCatgroupNameType()
  

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

  Returns:

  The type of search on the catalog group name criteria.

• getIdentifier

  public java.lang.String getIdentifier()
  

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

  Returns:

  The catalog group identifier in the identifier criteria.

• getIdentifierType

  public java.lang.String getIdentifierType()
  

  This method returns the type of search that is being performed to the catalog group identifier criteria.

  Returns:

  The type of search on the catalog group identifier 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 group 'mark for delete' flag.

• getPublished

  public java.lang.String getPublished()
  

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

  Returns:

  The catalog group 'published' flag.

• setCatalogGroupList

  public void setCatalogGroupList(java.util.Vector newCatalogGroupList)
  

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

  Parameters:

  newCatalogGroupList - The list of catalog group data beans.

• setCatgroupName

  public void setCatgroupName(java.lang.String newCatgroupName)
  

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

  Parameters:

  newCatgroupName - The catalog group name in the name criteria.

• setCatgroupNameType

  public void setCatgroupNameType(java.lang.String newCatgroupNameType)
  

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

  Parameters:

  newCatgroupNameType - The type of search on the catalog group name criteria.

• setIdentifier

  public void setIdentifier(java.lang.String newIdentifier)
  

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

  Parameters:

  newIdentifier - The catalog group identifier in the identifier criteria.

• setIdentifierType

  public void setIdentifierType(java.lang.String newIdentifierType)
  

  This method sets the type of search that is being performed to the catalog group identifier criteria.

  Parameters:

  newIdentifierType - The type of search on the catalog group identifier 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 group 'mark for delete' flag.

• 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 group 'published' flag.