com.ibm.commerce.search.beans

Class AdvancedCatEntrySearchListDataBean

  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean, com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean, SearchConstants, java.io.Serializable
    Direct Known Subclasses:
    RLCatEntrySearchListDataBean

    public class AdvancedCatEntrySearchListDataBean
extends CatEntrySearchListDataBean
    This bean is used to retrieve product, item, package, or bundle information from catalog based on input search criteria. This bean extends CatEntrySearchListDataBean and has following additional functionality:
    1. this bean can return a product, item, package, or bundle,
    2. the user can turn on entitlement,
    3. the user can search for catentries that are not published and not buyable,
    4. this bean provides additional search constraints. See the list of variables that a user may enter below.

    This bean can be used to customize both WebSphere Commerce tooling and stores. However, it is recommended to use this bean only for tooling and not for stores. The user may enter search criteria using a JSP. A user can enter the following variables using a JSP:
    These variables are used to set the last update value for the search.
    1. lastUpdate (String): The value of this variable is used in search based on Lastupdate (Catentry.Lastupdate column).
    2. lastUpdateOperator (String) : 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.

    These variables are used to set the availability information for the search.
    1. availabilityDate (String): The value of this variable is used in search based on availability date (Catentry.Availabilitydate column).
    2. availabilityDateOperator (String) : 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.'
    3. available (String): The value of this variable is used in search based on available time (Catentry.Available column).
    4. availableOperator (String) : 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.'

    This variable is used to set the result type for the search.
    1. resultType (String) : You can display products, items, or both products and items in a search result. The value in this variable is used to store this value. The value must be 1 (Items only), 2 (Products only) or 3 (both products and items). This field is deprecated and exists for backward compatibility only. Use the methods isPackage, isBundle, isProduct, isItem, or isDynamicKit.

    This variable is used to set the entitlement value for the search, either on or off.
    1. isEntitlementOn (boolean): The value is used to turn entitlement on / off.

    These variables are used to set the buyable value for the search, based on the buyable column in the CATENTRY database table..
    1. buyable (String): The value is used to search on buyable (catentry.buyable column).
    2. buyableOperator (String) : 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.'

    These variables are used to set the published value for the search, based on the published column in the CATENDESC database table.
    1. published (String): The value is used to search the database table and column CATENDESC.PUBLISHED.
    2. publishedOperator (String) : 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.'

    These variables are used to set the mark for delete flag to be used for the search.
    1. markForDelete (String): The value is used to search on markForDelete (catentry.markfordelete column).
    2. markForDeleteOperator (String) : 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.'

    These variables are used to set the on auction values to be used for the search. These values are based on the onauction column of the CATENTRY database table.
    1. onAuction (String): The value is used to search on onAuction (catentry.onAuction column).
    2. onAuctionOperator (String) : 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.'

    These variables are used to set the on special values to be used for the search. These values are based on the onspecial column of the CATENTRY database table.
    1. onSpecial (String): The value is used to search on onSpecial (catentry.onspecial column).
    2. onSpecialOperator (String) : 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.'

    These variables are used to set the name value to be used for the search.
    1. name (String): The value of this variable is used in search based on catentry name (Catentdesc.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. nameTermOperator (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 value to be used for the search.
    1. shortDesc (String): The value of this variable is used in search based on catentry shortdescription (Catentdesc.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 keyword value to be used for the search. These values are based on the keyword column in the CATENTDESC database table.
    1. keyword (String): The value of this variable is used in search based on catentry keyword (Catentdesc.keyword column).
    2. keywordCaseSensitive (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. keywordOperator (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. keywordType (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 to be used 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 (String) : 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.'

    This variable is used to set the catalog ID value to be used for the search.
    1. catalogId (String): The value of this variable is used to search based on catalog.

    These variables are used to set the catentry type to be used for the search.
    1. isProduct (boolean): Returns results of 'product data bean' catentry type
    2. isItem (boolean): Returns results of 'item data bean' catentry type
    3. isDynamicKit (boolean): Returns results of 'dynamic kit data bean' catentry type
    4. isPackage (boolean): Set this to true if package ids must be returned, by default it is false.
    5. isBundle (boolean): Set this to false if bundle ids must be returned, by default it is false.

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

     
                  advancedCatEntrySearchDB.setName("Circular Saw"); 
                  advancedCatEntrySearchDB.setNameCaseSensitive("true"); 
                  advancedCatEntrySearchDB.setNameTermOperator("EQUAL"); 
                  advancedCatEntrySearchDB.setNameType("ALL");
    See Also:
    Serialized Form

    • Constructor Detail

      • AdvancedCatEntrySearchListDataBean

        public AdvancedCatEntrySearchListDataBean()
        AdvancedCatEntrySearchListDataBean constructor comment.

    • Method Detail

      • getAvailabilityDate

        public java.lang.String getAvailabilityDate()
        The value of this variable is used in search based on availability date (Catentry.Availabilitydate column).
        Returns:
        java.lang.String. The availability date.

      • getAvailabilityDateOperator

        public java.lang.String getAvailabilityDateOperator()
        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.'
        Returns:
        java.lang.String. The value used for the available date operator criteria in the search.

      • getAvailable

        public java.lang.String getAvailable()
        The value of this variable is used in search based on available time (Catentry.Available column).
        Returns:
        java.lang.String. The value used for the available criteria in the search.

      • getAvailableOperator

        public java.lang.String getAvailableOperator()
        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.'
        Returns:
        java.lang.String. The value used for the available operator criteria in the search.

      • getBuyable

        public java.lang.String getBuyable()
        The value is used to search on buyable (catentry.buyable column).
        Returns:
        java.lang.String. The value used for the buyable criteria in the search.

      • getBuyableOperator

        public java.lang.String getBuyableOperator()
        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.'
        Returns:
        java.lang.String. The value used for the buyable operator criteria in the search.

      • getKeyword

        public java.lang.String getKeyword()
        The value of this variable is used in search based on catentry keyword (Catentdesc.keyword column).
        Returns:
        java.lang.String. The value used for the keyword criteria in the search.

      • getKeywordCaseSensitive

        public java.lang.String getKeywordCaseSensitive()
        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 value used for the keyword case sensitive criteria in the search.

      • getKeywordOperator

        public java.lang.String getKeywordOperator()
        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.'
        Returns:
        java.lang.String. The value used for the keyword operator criteria in the search.

      • getKeywordType

        public java.lang.String getKeywordType()
        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 value used for the keyword type criteria in the search.

      • getLastUpdate

        public java.lang.String getLastUpdate()
        The value of this variable is used in search based on Lastupdate (Catentry.Lastupdate column).
        Returns:
        java.lang.String. The value used for the lastUpdate criteria in the search.

      • getLastUpdateOperator

        public java.lang.String getLastUpdateOperator()
        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.'
        Returns:
        java.lang.String. The value used for the lastUpdate operator criteria in the search.

      • getMarkForDelete

        public java.lang.String getMarkForDelete()
        The value is used to search on markForDelete (catentry.markfordelete column).
        Returns:
        java.lang.String. The value used for the mark for delete criteria in the search.

      • getMarkForDeleteOperator

        public java.lang.String getMarkForDeleteOperator()
        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.'
        Returns:
        java.lang.String. The value used for the mark for delete operator criteria in the search.

      • getName

        public java.lang.String getName()
        The value of this variable is used in search based on catentry name (Catentdesc.name column).
        Returns:
        java.lang.String. The value used for the name criteria in the search.

      • getNameCaseSensitive

        public java.lang.String getNameCaseSensitive()
        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 value used for the name case sensitive criteria in the search.

      • getNameTermOperator

        public java.lang.String getNameTermOperator()
        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 value used for the name term operator criteria in the search.

      • getNameType

        public java.lang.String getNameType()
        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 value used for the name type criteria in the search.

      • getOnAuction

        public java.lang.String getOnAuction()
        The value is used to search on onAuction (catentry.onAuction column).
        Returns:
        java.lang.String. The value used for the onAuction criteria in the search.

      • getOnAuctionOperator

        public java.lang.String getOnAuctionOperator()
        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.'
        Returns:
        java.lang.String. The value used for the onAuction operator criteria in the search.

      • getOnSpecial

        public java.lang.String getOnSpecial()
        The value is used to search on onSpecial (catentry.onspecial column).
        Returns:
        java.lang.String. The value used for the onSpecial criteria in the search.

      • getOnSpecialOperator

        public java.lang.String getOnSpecialOperator()
        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.'
        Returns:
        java.lang.String. The value used for the onSpecial operator criteria in the search.

      • getPublished

        public java.lang.String getPublished()
        The value is used to search on published (catentry.published column).
        Returns:
        java.lang.String. The value used for the published criteria in the search.

      • getPublishedOperator

        public java.lang.String getPublishedOperator()
        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.'
        Returns:
        java.lang.String. The value used for the published operator criteria in the search.

      • getShortDesc

        public java.lang.String getShortDesc()
        The value of this variable is used in search based on catentry shortdescription (Catentdesc.shortdescription column).
        Returns:
        java.lang.String. The value used for the short description criteria in 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 value used for the short description case sensitive criteria in 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 value used for the short description operator criteria in 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 value used for the short description type criteria in the search.

      • getStoreId

        public java.lang.String getStoreId()
        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 ','.
        Returns:
        java.lang.String. The value used for the storeId criteria in the search.

      • getStoreIdOperator

        public java.lang.String getStoreIdOperator()
        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.'
        Returns:
        java.lang.String. The value used for the storeId operator criteria in the search.

      • getStoreIds

        public java.lang.String getStoreIds()
        A user can specify a number of stores to search on. It can be single store or multiple store. In case of multiple store each store has to be delimited by spaces only.
        Returns:
        java.lang.String. The value used for the storeIds criteria in the search.

      • getStoreIdsOperator

        public java.lang.String getStoreIdsOperator()
        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.'
        Returns:
        java.lang.String. The value used for the storeIds operator criteria in the search.

      • isIsBundle

        public boolean isIsBundle()
        Set this to false if bundle ids must be returned, by default it is false.
        Overrides:
        isIsBundle in class CatEntrySearchListDataBean
        Returns:
        boolean

      • isRemoveDefaultContract

        public boolean isRemoveDefaultContract()

      • setRemoveDefaultContract

        public void setRemoveDefaultContract(boolean bool)

      • isIsDynamicKit

        public boolean isIsDynamicKit()
        isDynamicKit (boolean): Returns results of 'dynamic kit data bean' catentry type
        Overrides:
        isIsDynamicKit in class CatEntrySearchListDataBean
        Returns:
        boolean

      • isIsPackage

        public boolean isIsPackage()
        Set this to true if package ids must be returned, by default it is false.
        Overrides:
        isIsPackage in class CatEntrySearchListDataBean
        Returns:
        boolean

      • setAvailabilityDate

        public void setAvailabilityDate(java.lang.String newAvailabilityDate)
        The value of this variable is used in search based on availability date (Catentry.Availabilitydate column).
        Parameters:
        newAvailabilityDate - java.lang.String. The availability date used for the search.

      • setAvailabilityDateOperator

        public void setAvailabilityDateOperator(java.lang.String newAvailabilityDateOperator)
        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.'
        Parameters:
        newAvailabilityDateOperator - java.lang.String. The availability date operator, one of EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

      • setAvailable

        public void setAvailable(java.lang.String newAvailable)
        The value of this variable is used in search based on available time (Catentry.Available column).
        Parameters:
        newAvailable - java.lang.String. The available time value used for the search.

      • setAvailableOperator

        public void setAvailableOperator(java.lang.String newAvailableOperator)
        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.'
        Parameters:
        newAvailableOperator - java.lang.String. The available time operator.

      • setBuyable

        public void setBuyable(java.lang.String newBuyable)
        The value is used to search on buyable (catentry.buyable column).
        Parameters:
        newBuyable - java.lang.String. The buyable value used for the search.

      • setBuyableOperator

        public void setBuyableOperator(java.lang.String newBuyableOperator)
        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.'
        Parameters:
        newBuyableOperator - java.lang.String. The buyable operator, one of EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

      • setIsBundle

        public void setIsBundle(boolean newIsBundle)
        Set this to false if bundle ids must be returned, by default it is false.
        Overrides:
        setIsBundle in class CatEntrySearchListDataBean
        Parameters:
        newIsBundle - boolean. The isBundle flag value.

      • setIsDynamicKit

        public void setIsDynamicKit(boolean newIsDynamicKit)
        isDynamicKit (boolean): Returns results of 'dynamic kit data bean' catentry type
        Overrides:
        setIsDynamicKit in class CatEntrySearchListDataBean
        Parameters:
        newIsDynamicKit - boolean. The isDynamicKit flag value.

      • setIsItem

        public void setIsItem(boolean newIsItem)
        Returns results of 'item data bean' catentry type
        Overrides:
        setIsItem in class CatEntrySearchListDataBean
        Parameters:
        newIsItem - boolean. The isItem flag value.

      • setIsPackage

        public void setIsPackage(boolean newIsPackage)
        Set this to true if package ids must be returned, by default it is false.
        Overrides:
        setIsPackage in class CatEntrySearchListDataBean
        Parameters:
        newIsPackage - boolean. The isPackage flag value.

      • setIsProduct

        public void setIsProduct(boolean newIsProduct)
        Returns results of 'product data bean' catentry type
        Overrides:
        setIsProduct in class CatEntrySearchListDataBean
        Parameters:
        newIsProduct - boolean. The isProduct flag value.

      • setKeyword

        public void setKeyword(java.lang.String newKeyword)
        The value of this variable is used in search based on catentry keyword (Catentdesc.keyword column).
        Parameters:
        newKeyword - java.lang.String. The isKeyword flag value.

      • setKeywordCaseSensitive

        public void setKeywordCaseSensitive(java.lang.String newKeywordCaseSensitive)
        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:
        newKeywordCaseSensitive - java.lang.String. The keyword case sensitive value, either 'yes' or 'no'.

      • setKeywordOperator

        public void setKeywordOperator(java.lang.String newKeywordOperator)
        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.'
        Parameters:
        newKeywordOperator - java.lang.String. The keyword operator, one of EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

      • setKeywordType

        public void setKeywordType(java.lang.String newKeywordType)
        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:
        newKeywordType - java.lang.String. The keyword search criteria, either 'ALL', 'ANY', or 'EXACT'.

      • setLastUpdate

        public void setLastUpdate(java.lang.String newLastUpdate)
        The value of this variable is used in search based on Lastupdate (Catentry.Lastupdate column).
        Parameters:
        newLastUpdate - java.lang.String. The last update value used for the search.

      • setLastUpdateOperator

        public void setLastUpdateOperator(java.lang.String newLastUpdateOperator)
        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.'
        Parameters:
        newLastUpdateOperator - java.lang.String. The last update operator, one of EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

      • setMarkForDelete

        public void setMarkForDelete(java.lang.String newMarkForDelete)
        The value is used to search on markForDelete (catentry.markfordelete column).
        Parameters:
        newMarkForDelete - java.lang.String. The mark for delete flag value.

      • setMarkForDeleteOperator

        public void setMarkForDeleteOperator(java.lang.String newMarkForDeleteOperator)
        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.'
        Parameters:
        newMarkForDeleteOperator - java.lang.String. the mark for delete flag operator, one of EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

      • setName

        public void setName(java.lang.String newName)
        The value of this variable is used in search based on catentry name (Catentdesc.name column).
        Parameters:
        newName - java.lang.String. The name used for the search.

      • setNameCaseSensitive

        public void setNameCaseSensitive(java.lang.String newNameCaseSensitive)
        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:
        newNameCaseSensitive - java.lang.String. The name case sensitive value, either 'yes', or 'no'.

      • setNameTermOperator

        public void setNameTermOperator(java.lang.String newNameTermOperator)
        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:
        newNameTermOperator - java.lang.String. The name operator, either 'like' or 'equal'.

      • setNameType

        public void setNameType(java.lang.String newNameType)
        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:
        newNameType - java.lang.String. The name search criteria, either 'ALL', 'ANY', or 'EXACT'.

      • setOnAuction

        public void setOnAuction(java.lang.String newOnAuction)
        The value is used to search on onAuction (catentry.onAuction column).
        Parameters:
        newOnAuction - java.lang.String. The on auction value used for the search.

      • setOnAuctionOperator

        public void setOnAuctionOperator(java.lang.String newOnAuctionOperator)
        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.'
        Parameters:
        newOnAuctionOperator - java.lang.String. The on auction operator, one of EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

      • setOnSpecial

        public void setOnSpecial(java.lang.String newOnSpecial)
        The value is used to search on onSpecial (catentry.onspecial column).
        Parameters:
        newOnSpecial - java.lang.String. The on special value used for the search.

      • setOnSpecialOperator

        public void setOnSpecialOperator(java.lang.String newOnSpecialOperator)
        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.'
        Parameters:
        newOnSpecialOperator - java.lang.String. The on special operator, one of EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

      • setPublished

        public void setPublished(java.lang.String newPublished)
        The value is used to search on published (catentry.published column).
        Parameters:
        newPublished - java.lang.String. The published value used for the search.

      • setPublishedOperator

        public void setPublishedOperator(java.lang.String newPublishedOperator)
        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.'
        Parameters:
        newPublishedOperator - java.lang.String. The published operator, one of EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

      • setShortDesc

        public void setShortDesc(java.lang.String newShortDesc)
        The value of this variable is used in search based on catentry shortdescription (Catentdesc.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 short description case sensitive value, either 'yes' or 'no'.

      • 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 short description operator, 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 short description type, either 'ALL', 'ANY', or 'EXACT'.

      • setStoreId

        public void setStoreId(java.lang.String newStoreId)
        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 ','.
        Parameters:
        newStoreId - java.lang.String. The store ID used for the search.

      • setStoreIdOperator

        public void setStoreIdOperator(java.lang.String newStoreIdOperator)
        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.'
        Parameters:
        newStoreIdOperator - java.lang.String. The store ID operator, one of EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

      • setStoreIds

        public void setStoreIds(java.lang.String newStoreIds)
        A user can specify a number of stores to search on. It can be single store or multiple store. In case of multiple store each store has to be delimited by spaces only.
        Parameters:
        newStoreId - java.lang.String. A list of store IDs to search, delimited by spaces.

      • setStoreIdsOperator

        public void setStoreIdsOperator(java.lang.String newStoreIdsOperator)
        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.
        Parameters:
        newStoreIdOperator - java.lang.String. The operator used for the list of store IDs to search, one of EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.
Skip navigation links