com.ibm.commerce.search.beans

Class CatalogSearchListDataBean

  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, SearchConstants, java.io.Serializable


    public class CatalogSearchListDataBean
    extends SearchBaseDataBean
    This bean is used to retrieve catalog identifier information from master catalog based on input search criteria. This bean extends CatalogSearchBaseDataBean. The user can enter search criteria using a JSP. A user can enter the following variables using a JSP:
    These variables are used to set the catalog name for the search.
    1. name (String): The value of this variable is used in search based on catalog name (Catalogdsc.name column).
    2. nameCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
    3. nameOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
    4. nameType (String) : A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).

    These variables are used to set the short description for the search.
    1. shortDesc (String): The value of this variable is used in search based on catalog shortdescription (Catalogdsc.shortdescription column).
    2. shortDescCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
    3. shortDescOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
    4. shortDescType (String) : A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).

    These variables are used to set the description for the search.
    1. admnDesc (String): The value of this variable is used in search based on catalog description (Catalog.description column).
    2. admnDescCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
    3. admnDescOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
    4. admnDescType (String) : A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).

    These variables are used to set the store ID for the search.
    1. storeId (String) : A user can specify the store to search on. It can be single store or multiple store. In case of multiple store each store has to be delimited by ','.
    2. storeIdOperator: A user can choose one of the following operators as search operators: =, <, >, !=, <=, >=. The value in this variable is used to store a user's choice. The value must be any one of the following: EQUAL, 'NOTEQUAL,' GREATER, LESS, GREATER_EQUAL, LESS_EQUAL, IN.

    These variables are used to set the identifier for the search.
    1. identifier (String): The value of this variable is used in search based on catalog identifier (Catalog.identifier column).
    2. identifierCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
    3. identifierOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
    4. identifierType (String) : A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).

    This variable is used to set the catalog type for the search.
    1. catalogType (Integer) : The value of this variable is used to search on navigational or master catalog. Possible values are MASTER_CATALOG or NAVIGATIONAL_CATALOG. By default the value is MASTER_CATALOG.

    A sample usage follows for a search based on a catalog name:

                       
                   catalogSearchDB.setName("Fall Fashions"); 
                   catalogSearchDB.setNameCaseSensitive("true"); 
                   catalogSearchDB.setNameTermOperator("EQUAL"); 
                   catalogSearchDB.setNameType("STRING");            
     
    See Also:
    Serialized Form
    • Constructor Detail

      • CatalogSearchListDataBean

        public CatalogSearchListDataBean()
        CatalogSearchListDataBean constructor comment.
    • Method Detail

      • getAdmnDesc

        public java.lang.String getAdmnDesc()
        A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
        Returns:
        java.lang.String. The admin description value used for the search.
      • getAdmnDescCaseSensitive

        public java.lang.String getAdmnDescCaseSensitive()
        A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
        Returns:
        java.lang.String. The admin description case sensitive value used for the search.
      • getAdmnDescOperator

        public java.lang.String getAdmnDescOperator()
        A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
        Returns:
        java.lang.String. The admin description Operator value used for the search.
      • getAdmnDescType

        public java.lang.String getAdmnDescType()
        A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).
        Returns:
        java.lang.String. The admin description Type value used for the search.
      • getCatalogType

        public java.lang.Integer getCatalogType()
        The value of this variable is used to search on navigational or master catalog. Possible values are MASTER_CATALOG or NAVIGATIONAL_CATALOG. By default the value is MASTER_CATALOG.
        Returns:
        java.lang.Integer. The catalog Type value used for the search.
      • getDistinct

        public java.lang.String getDistinct()
        Defines SQL distinct qualifier. It is useful when using order by where distinct qualifier is not permitted.
        Returns:
        java.lang.String. The DISTINCT value used for the search.
      • getIdentifier

        public java.lang.String getIdentifier()
        The value of this variable is used in search based on catalog identifier (Catalog.identifier column).
        Returns:
        java.lang.String. The identifier value used for the search.
      • getIdentifierCaseSensitive

        public java.lang.String getIdentifierCaseSensitive()
        Returns identifierCaseSensitive.
        Returns:
        java.lang.String. The identifier case sensitive value used for the search.
      • getIdentifierOperator

        public java.lang.String getIdentifierOperator()
        A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
        Returns:
        java.lang.String. The identifier Operator value used for the search.
      • getIdentifierType

        public java.lang.String getIdentifierType()
        A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).
        Returns:
        java.lang.String. The identifier type value used for the search.
      • getLangId

        public java.lang.String getLangId()
        The langId to search. If not provided the default from command context will be used.
        Returns:
        java.lang.String. The language ID value used for the search.
      • getName

        public java.lang.String getName()
        Returns name.
        Returns:
        java.lang.String. The name value used for the search.
      • getNameCaseSensitive

        public java.lang.String getNameCaseSensitive()
        Returns nameCaseSensitive.
        Returns:
        java.lang.String. The name case sensitive value used for the search.
      • getNameTermOperator

        public java.lang.String getNameTermOperator()
        Returns nameTermOperator.
        Returns:
        java.lang.String. The name term operator value used for the search.
      • getNameType

        public java.lang.String getNameType()
        Returns nameType.
        Returns:
        java.lang.String. The name type value used for the search.
      • getResultCount

        public java.lang.String getResultCount()
        Returns resultCount
        Overrides:
        getResultCount in class SearchBaseDataBean
        Returns:
        The number of rows retrieved for this search criteria.
      • getResultList

        public CatalogDataBean[] getResultList()
        Search results as array of CatalogDataBeans from resultSet variable.
        Returns:
        com.ibm.commerce.catalog.beans.CatalogDataBean[]
      • getResultName

        public java.lang.String getResultName()
        Column names for building a result set. See valid column names in AttributeInfoDictionary.initialize().
        Returns:
        java.lang.String. The result name value used for the search.
      • getResultSet

        public java.util.Vector getResultSet()
        Search results as vector of vectors of strings containing rows with result set columns where first column must be Catalog ids.
        Returns:
        java.util.Vector. The result set value used for the search.
      • getResultSetName

        public java.util.Vector getResultSetName()
        Search results as vector of vectors of strings containing result set column names.
        Returns:
        java.lang.String. The result Set name value used for the search.
      • getShortDesc

        public java.lang.String getShortDesc()
        The value of this variable is used in search based on catalog shortdescription (Catalogdsc.shortdescription column).
        Returns:
        java.lang.String. The short description value used for the search.
      • getShortDescCaseSensitive

        public java.lang.String getShortDescCaseSensitive()
        A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
        Returns:
        java.lang.String. The short description case sensitive value used for the search.
      • getShortDescOperator

        public java.lang.String getShortDescOperator()
        A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
        Returns:
        java.lang.String. The short description operator value used for the search.
      • getShortDescType

        public java.lang.String getShortDescType()
        A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).
        Returns:
        java.lang.String. The short description type value used for the search.
      • getStoreId

        public java.lang.String getStoreId()
        Returns storeId.
        Returns:
        java.lang.String. The store ID value used for the search.
      • getStoreIdOperator

        public java.lang.String getStoreIdOperator()
        Returns storeIdOperator.
        Returns:
        java.lang.String. The store ID Operator value used for the search.
      • getUserId

        public int getUserId()
        Returns userId.
        Returns:
        int. The user ID value used for the search.
      • setAdmnDesc

        public void setAdmnDesc(java.lang.String newAdmnDesc)
        The value of this variable is used in search based on catalog description (Catalog.description column).
        Parameters:
        newAdmnDesc - java.lang.String. The admin description used in search based on catalog description.
      • setAdmnDescCaseSensitive

        public void setAdmnDescCaseSensitive(java.lang.String newAdmnDescCaseSensitive)
        A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
        Parameters:
        newAdmnDescCaseSensitive - java.lang.String. A value indicating whether the search is case sensitive or not, either 'yes', or 'no'.
      • setAdmnDescOperator

        public void setAdmnDescOperator(java.lang.String newAdmnDescOperator)
        A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
        Parameters:
        newAdmnDescOperator - java.lang.String. The search operator value, either 'like' or 'equal'.
      • setAdmnDescType

        public void setAdmnDescType(java.lang.String newAdmnDescType)
        A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).
        Parameters:
        newAdmnDescType - java.lang.String. The search criteria value, either 'ALL', 'ANY', or 'EXACT'.
      • setCatalogType

        public void setCatalogType(java.lang.Integer newCatalogType)
        The value of this variable is used to search on navigational or master catalog. Possible values are MASTER_CATALOG or NAVIGATIONAL_CATALOG. By default the value is MASTER_CATALOG.
        Parameters:
        newCatalogType - java.lang.Integer. The type of catalog to be searched. Possible values include the default MASTER_CATALOG, or NAVIGATIONAL_CATALOG.
      • setDistinct

        public void setDistinct(java.lang.String newDistinct)
        Defines SQL distinct qualifier. It is useful when using order by where distinct qualifier is not permitted.
        Parameters:
        newDistinct - java.lang.String. The SQL distinct qualifier.
      • setIdentifier

        public void setIdentifier(java.lang.String newIdentifier)
        The value of this variable is used in search based on catalog identifier (Catalog.identifier column).
        Parameters:
        newIdentifier - java.lang.String. The catalog identifier.
      • setIdentifierCaseSensitive

        public void setIdentifierCaseSensitive(java.lang.String newIdentifierCaseSensitive)
        To set identifierCaseSensitive.
        Parameters:
        newIdentifierCaseSensitive - java.lang.String. The case sensitive status of the new identifier.
      • setIdentifierOperator

        public void setIdentifierOperator(java.lang.String newIdentifierOperator)
        A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
        Parameters:
        newIdentifierTermOperator - java.lang.String. The identifier term operator, either 'like', or 'equal'.
      • setIdentifierType

        public void setIdentifierType(java.lang.String newIdentifierType)
        A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).
        Parameters:
        newIdentifierType - java.lang.String. The search criteria for the identifier, either 'ALL', 'ANY', or 'EXACT'.
      • setLangId

        public void setLangId(java.lang.String newLangId)
        The langId to search. If not provided the default from command context will be used.
        Parameters:
        newLangId - java.lang.String. The language ID used in the search.
      • setName

        public void setName(java.lang.String newName)
        To set name.
        Parameters:
        newName - java.lang.String. The name used in the search.
      • setNameCaseSensitive

        public void setNameCaseSensitive(java.lang.String newNameCaseSensitive)
        To set nameCaseSensitive.
        Parameters:
        newNameCaseSensitive - java.lang.String. The case sensitive status for the name.
      • setNameTermOperator

        public void setNameTermOperator(java.lang.String newNameTermOperator)
        To set nameTermOperator.
        Parameters:
        newNameTermOperator - java.lang.String. The operator used for the name, either 'like' or 'equal'
      • setNameType

        public void setNameType(java.lang.String newNameType)
        To set nameType.
        Parameters:
        newNameType - java.lang.String. The name type used in the search.
      • getOrderBy1

        public java.lang.String getOrderBy1()
        Result set will be sorted by this attribute.
        Returns:
        java.lang.String
      • getOrderByOperator1

        public java.lang.String getOrderByOperator1()
        Attributes can be sorted by ascending (default) or descending order.
        Returns:
        java.lang.String
      • setResultCount

        public void setResultCount(java.lang.String newResultCount)
        To set resultCount.
        Overrides:
        setResultCount in class SearchBaseDataBean
        Parameters:
        newResultCount - java.lang.String. The result count for the search.
      • setResultList

        public void setResultList(CatalogDataBean[] newResultList)
        Search results as array of CatalogDataBeans from resultSet variable.
        Parameters:
        newResultList - com.ibm.commerce.catalog.beans.CatalogDataBean[]. The result list array from the search.
      • setResultName

        public void setResultName(java.lang.String newResultName)
        Search results as vector of vectors of strings containing result set column names.
        Parameters:
        newResultName - java.lang.String. The result name.
      • setResultSet

        public void setResultSet(java.util.Vector newResultSet)
        Search results as vector of vectors of strings containing rows with result set columns where first column must be Catalog ids.
        Parameters:
        newResultSet - java.util.Vector. A vector of vectors of strings containing rows with result set columns.
      • setResultSetName

        public void setResultSetName(java.lang.String newResultName)
        Search results as vector of vectors of strings containing result set column names.
        Parameters:
        setResultSetName - java.lang.String. A vector of vectors of strings containing result set column names.
      • setShortDesc

        public void setShortDesc(java.lang.String newShortDesc)
        The value of this variable is used in search based on catalog shortdescription (Catalogdsc.shortdescription column).
        Parameters:
        newShortDesc - java.lang.String. The short description used for the search.
      • setShortDescCaseSensitive

        public void setShortDescCaseSensitive(java.lang.String newShortDescCaseSensitive)
        A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
        Parameters:
        newShortDescCaseSensitive - java.lang.String. The case sensitive status used for the short description in the search.
      • setShortDescOperator

        public void setShortDescOperator(java.lang.String newShortDescOperator)
        A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
        Parameters:
        newShortDescOperator - java.lang.String. The operator for the short description, either 'like' or 'equal'.
      • setShortDescType

        public void setShortDescType(java.lang.String newShortDescType)
        A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).
        Parameters:
        newShortDescType - java.lang.String. The search criteria for the short description, either 'ALL', 'ANY', or 'EXACT'.
      • setStoreId

        public void setStoreId(java.lang.String newStoreId)
        To set storeId.
        Parameters:
        newStoreId - java.lang.String. The store ID.
      • setStoreIdOperator

        public void setStoreIdOperator(java.lang.String newStoreIdOperator)
        To set storeIdOperator.
        Parameters:
        newStoreIdOperator - java.lang.String. The store ID operator.
      • setUserId

        public void setUserId(int newUserId)
        To set userId.
        Parameters:
        newUserId - int. The user ID.