com.ibm.commerce.tools.contract.beans
Class ProductSearchListDataBean

java.lang.Object
  |
  +--com.ibm.commerce.beans.InputDataBeanImpl
        |
        +--com.ibm.commerce.beans.SmartDataBeanImpl
              |
              +--com.ibm.commerce.tools.contract.beans.ProductSearchListDataBean
All Implemented Interfaces:
DataBean, InputDataBean, java.io.Serializable, SmartDataBean

public class ProductSearchListDataBean
extends SmartDataBeanImpl

Find Catalog Entries or Categories in a store

See Also:
Serialized Form

Field Summary
protected  java.lang.String _searchType
           
static java.lang.String CATENTRY_TYPE_BUNDLE
          Catentry type constants
static java.lang.String CATENTRY_TYPE_DYNAMIC_KIT
          Catentry type constants
static java.lang.String CATENTRY_TYPE_ITEM
          Catentry type constants
static java.lang.String CATENTRY_TYPE_PACKAGE
          Catentry type constants
static java.lang.String CATENTRY_TYPE_PRODUCT
          Catentry type constants
static java.lang.String ORDER_BY_CATEGORY_IDENTIFIER
          Order by constants
static java.lang.String ORDER_BY_CATEGORY_NAME
          Order by constants
static java.lang.String ORDER_BY_CATEGORY_SHORTDESCRIPTION
          Order by constants
static java.lang.String ORDER_BY_PRODUCT_CODE
          Order by constants
static java.lang.String ORDER_BY_PRODUCT_NAME
          Order by constants
static java.lang.String ORDER_BY_SHORTDESCRIPTION
          Order by constants
static java.lang.String TYPE_LIKE_CASE_SENSITIVE
          Pattern match type constants
static java.lang.String TYPE_LIKE_IGNORE_CASE
          Pattern match type constants
static java.lang.String TYPE_MATCH_CASE_SENSITIVE
          Pattern match type constants
static java.lang.String TYPE_MATCH_IGNORE_CASE
          Pattern match type constants
 
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
commandContext, COPYRIGHT
 
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl
requestProperties
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
ProductSearchListDataBean()
          Create a ProductSearchListDataBean
 
Method Summary
static java.lang.String escapeSQLstring(java.lang.String result)
          Receives a string to be used in a SQL command and inserts any necessary escape characters.
 java.lang.String getCatalogEntryType()
          Get the catalog entry type
 java.lang.String getCatalogID()
          Get the store identifier
  ProductSearchDataBean[] getCatalogList()
          Get the list of entries that were found
  ProductSearchDataBean getCatalogListData(int index)
          Get a specific entry that was found
 java.lang.String getDefaultLanguageID()
          Get the language identifier for the language in which to search
 java.lang.String getIndexBegin()
          Get the beginning index into the search results
 java.lang.String getIndexEnd()
          Get the end index into the search results
 java.lang.String getLanguageID()
          Get the language identifier for the language in which to search
 int getListSize()
          Get the size of the search results list
 java.lang.String getMemberID()
          Get the member identifer
 java.lang.String getName()
          Get the name of the item to search for
 java.lang.String getNameLike()
          Get the type of name search
 java.lang.String getOrderBy()
          Get the parameter to order the results by
 java.lang.String getPartNumber()
          Get the SKU to search for
 java.lang.String getPartNumberLike()
          Get the type of SKU search
  TypedProperty getRequestProperties()
          Get the request properties
 int getResultSetSize()
          Get the total number of entries found
 java.lang.String getShortDescription()
          Get the short description to search for
 java.lang.String getShortDescriptionLike()
          Get the type of short description search
 java.lang.String getStoreEntityIdWhereClause(java.lang.Integer storeId, java.lang.String prefix)
          Get the where clause that includes the stores on the store path
 java.lang.String getStoreID()
          Get the store identifier
static java.lang.String getUpperCaseFunction()
          Insert the method's description here.
 void populate()
          Populate the Category or Catalog Entry data
 void setCatalogEntryType(java.lang.String catEntType)
          Set the type of catalog entry identifier search
 void setCatalogID(java.lang.String newCatalogID)
          Set the catalog identifier
 void setCatalogList(java.util.Vector newCatalogList)
          Set the list of results found
 void setIndexBegin(java.lang.String newIndexBegin)
          Set the starting index of the result items
 void setIndexEnd(java.lang.String newIndexEnd)
          Set the end index of the result items
 void setLanguageID(java.lang.String newLanguageID)
          Set the language identifier in which to search
 void setMemberID(java.lang.String newMemberID)
          Set the member identifier
 void setName(java.lang.String newName)
          Set the name to search for
 void setNameLike(java.lang.String newNameLike)
          Set the type of name search
 void setOrderBy(java.lang.String newOrderBy)
          Set the parameter in which to sort by
 void setPartNumber(java.lang.String newPartNumber)
          Set the SKU to search for
 void setPartNumberLike(java.lang.String newPartNumberLike)
          Set the type of SKU search
 void setRequestProperties( TypedProperty param)
          Set the request properties
 void setResultSetSize(int newResultSetSize)
          Set the total number of results
 void setSearchType(java.lang.String searchType)
          Set the type of search to perform
 void setShortDescription(java.lang.String newShortDescription)
          Set the short description to search for
 void setShortDescriptionLike(java.lang.String newShortDescriptionLike)
          Set the type of short description search
 void setStoreID(java.lang.String newStoreID)
          Set the store identifier
 
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
fulfills, getCommandContext, getResources, setCommandContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ORDER_BY_PRODUCT_CODE

public static final java.lang.String ORDER_BY_PRODUCT_CODE
Order by constants
See Also:
Constant Field Values

ORDER_BY_PRODUCT_NAME

public static final java.lang.String ORDER_BY_PRODUCT_NAME
Order by constants
See Also:
Constant Field Values

ORDER_BY_SHORTDESCRIPTION

public static final java.lang.String ORDER_BY_SHORTDESCRIPTION
Order by constants
See Also:
Constant Field Values

ORDER_BY_CATEGORY_NAME

public static final java.lang.String ORDER_BY_CATEGORY_NAME
Order by constants
See Also:
Constant Field Values

ORDER_BY_CATEGORY_SHORTDESCRIPTION

public static final java.lang.String ORDER_BY_CATEGORY_SHORTDESCRIPTION
Order by constants
See Also:
Constant Field Values

ORDER_BY_CATEGORY_IDENTIFIER

public static final java.lang.String ORDER_BY_CATEGORY_IDENTIFIER
Order by constants
See Also:
Constant Field Values

TYPE_LIKE_CASE_SENSITIVE

public static final java.lang.String TYPE_LIKE_CASE_SENSITIVE
Pattern match type constants
See Also:
Constant Field Values

TYPE_LIKE_IGNORE_CASE

public static final java.lang.String TYPE_LIKE_IGNORE_CASE
Pattern match type constants
See Also:
Constant Field Values

TYPE_MATCH_CASE_SENSITIVE

public static final java.lang.String TYPE_MATCH_CASE_SENSITIVE
Pattern match type constants
See Also:
Constant Field Values

TYPE_MATCH_IGNORE_CASE

public static final java.lang.String TYPE_MATCH_IGNORE_CASE
Pattern match type constants
See Also:
Constant Field Values

CATENTRY_TYPE_PRODUCT

public static final java.lang.String CATENTRY_TYPE_PRODUCT
Catentry type constants
See Also:
Constant Field Values

CATENTRY_TYPE_ITEM

public static final java.lang.String CATENTRY_TYPE_ITEM
Catentry type constants
See Also:
Constant Field Values

CATENTRY_TYPE_PACKAGE

public static final java.lang.String CATENTRY_TYPE_PACKAGE
Catentry type constants
See Also:
Constant Field Values

CATENTRY_TYPE_BUNDLE

public static final java.lang.String CATENTRY_TYPE_BUNDLE
Catentry type constants
See Also:
Constant Field Values

CATENTRY_TYPE_DYNAMIC_KIT

public static final java.lang.String CATENTRY_TYPE_DYNAMIC_KIT
Catentry type constants
See Also:
Constant Field Values

_searchType

protected java.lang.String _searchType
Constructor Detail

ProductSearchListDataBean

public ProductSearchListDataBean()
Create a ProductSearchListDataBean
Method Detail

escapeSQLstring

public static java.lang.String escapeSQLstring(java.lang.String result)
Receives a string to be used in a SQL command and inserts any necessary escape characters.

Behaviour:

\ is inserted before % _ ' and \
Parameters:
result - The string to be formatted for SQL.
Returns:
The formatted string.

getCatalogEntryType

public java.lang.String getCatalogEntryType()
Get the catalog entry type
Returns:
java.lang.String

getCatalogID

public java.lang.String getCatalogID()
Get the store identifier
Returns:
java.lang.String

getCatalogList

public ProductSearchDataBean[] getCatalogList()
Get the list of entries that were found
Returns:
ProductSearchDataBean[]

getCatalogListData

public ProductSearchDataBean getCatalogListData(int index)
                                         throws java.lang.ArrayIndexOutOfBoundsException
Get a specific entry that was found
Returns:
ProductSearchDataBean
java.lang.ArrayIndexOutOfBoundsException

getDefaultLanguageID

public java.lang.String getDefaultLanguageID()
                                      throws java.lang.Exception
Get the language identifier for the language in which to search
Returns:
java.lang.String
java.lang.Exception

getIndexBegin

public java.lang.String getIndexBegin()
Get the beginning index into the search results
Returns:
java.lang.String

getIndexEnd

public java.lang.String getIndexEnd()
Get the end index into the search results
Returns:
java.lang.String

getLanguageID

public java.lang.String getLanguageID()
                               throws java.lang.Exception
Get the language identifier for the language in which to search
Returns:
java.lang.String
java.lang.Exception

getListSize

public int getListSize()
Get the size of the search results list
Returns:
int

getMemberID

public java.lang.String getMemberID()
Get the member identifer
Returns:
java.lang.String

getName

public java.lang.String getName()
Get the name of the item to search for
Returns:
java.lang.String

getNameLike

public java.lang.String getNameLike()
Get the type of name search
Returns:
java.lang.String

getOrderBy

public java.lang.String getOrderBy()
Get the parameter to order the results by
Returns:
String

getPartNumber

public java.lang.String getPartNumber()
Get the SKU to search for
Returns:
java.lang.String

getPartNumberLike

public java.lang.String getPartNumberLike()
Get the type of SKU search
Returns:
java.lang.String

getRequestProperties

public TypedProperty getRequestProperties()
Get the request properties
Specified by:
getRequestProperties in interface InputDataBean
Overrides:
getRequestProperties in class InputDataBeanImpl
Returns:
com.ibm.commerce.datatype.TypedProperty

getResultSetSize

public int getResultSetSize()
Get the total number of entries found
Returns:
int

getShortDescription

public java.lang.String getShortDescription()
Get the short description to search for
Returns:
java.lang.String

getShortDescriptionLike

public java.lang.String getShortDescriptionLike()
Get the type of short description search
Returns:
java.lang.String

getStoreID

public java.lang.String getStoreID()
Get the store identifier
Returns:
java.lang.String

getUpperCaseFunction

public static final java.lang.String getUpperCaseFunction()
Insert the method's description here. Creation date: (6/14/00 2:29:12 PM)
Returns:
java.lang.String

populate

public void populate()
Populate the Category or Catalog Entry data
Specified by:
populate in interface SmartDataBean
Overrides:
populate in class SmartDataBeanImpl

setCatalogEntryType

public void setCatalogEntryType(java.lang.String catEntType)
Set the type of catalog entry identifier search

setCatalogID

public void setCatalogID(java.lang.String newCatalogID)
Set the catalog identifier

setCatalogList

public void setCatalogList(java.util.Vector newCatalogList)
Set the list of results found
Parameters:
newCatalogList - java.util.Vector

setIndexBegin

public void setIndexBegin(java.lang.String newIndexBegin)
Set the starting index of the result items
Parameters:
newIndexBegin - java.lang.String

setIndexEnd

public void setIndexEnd(java.lang.String newIndexEnd)
Set the end index of the result items
Parameters:
newIndexEnd - java.lang.String

setLanguageID

public void setLanguageID(java.lang.String newLanguageID)
Set the language identifier in which to search

setMemberID

public void setMemberID(java.lang.String newMemberID)
Set the member identifier
Parameters:
newMemberID - java.lang.String

setName

public void setName(java.lang.String newName)
Set the name to search for
Parameters:
newName - java.lang.String

setNameLike

public void setNameLike(java.lang.String newNameLike)
Set the type of name search
Parameters:
newNameLike - java.lang.String

setOrderBy

public void setOrderBy(java.lang.String newOrderBy)
Set the parameter in which to sort by
Parameters:
newOrderBy - java.lang.String

setPartNumber

public void setPartNumber(java.lang.String newPartNumber)
Set the SKU to search for
Parameters:
newPartNumber - java.lang.String

setPartNumberLike

public void setPartNumberLike(java.lang.String newPartNumberLike)
Set the type of SKU search
Parameters:
newPartNumberLike - java.lang.String

setRequestProperties

public void setRequestProperties(TypedProperty param)
Set the request properties
Specified by:
setRequestProperties in interface InputDataBean
Overrides:
setRequestProperties in class InputDataBeanImpl
Parameters:
param - com.ibm.commerce.datatype.TypedProperty

setResultSetSize

public void setResultSetSize(int newResultSetSize)
Set the total number of results
Parameters:
newResultSetSize - int

setSearchType

public void setSearchType(java.lang.String searchType)
Set the type of search to perform
Parameters:
searchType - String

setShortDescription

public void setShortDescription(java.lang.String newShortDescription)
Set the short description to search for
Parameters:
newShortDescription - java.lang.String

setShortDescriptionLike

public void setShortDescriptionLike(java.lang.String newShortDescriptionLike)
Set the type of short description search
Parameters:
newShortDescriptionLike - java.lang.String

setStoreID

public void setStoreID(java.lang.String newStoreID)
Set the store identifier
Parameters:
newStoreID - java.lang.String

getStoreEntityIdWhereClause

public java.lang.String getStoreEntityIdWhereClause(java.lang.Integer storeId,
                                                    java.lang.String prefix)
Get the where clause that includes the stores on the store path
Parameters:
storeId - java.lang.Integer
prefix - java.lang.String
Returns:
java.lang.String