com.beasys.commerce.ebusiness.catalog.rules
Class CatalogQueryWrapper

java.lang.Object
  com.beasys.commerce.ebusiness.catalog.rules.CatalogQueryWrapper

All Implemented Interfaces

CatalogRuleConstants

public class CatalogQueryWrapper
extends Object
implements CatalogRuleConstants

A wrapper/helper class that wraps a
com.beasys.commerce.ebusiness.catalog.service.query.CatalogQuery
and helps create an instance of the latter. The rules service creates this object by passing as arguments the type of the CatalogQuery and the query string.

Field Summary

protected String	catalogManagerName The CatalogManagerName.
protected KeywordQuery	keywordQuery The wrapped KeywordQuery.
protected int	maxResults The max query results returned.
protected ProductItemQuery	productItemQuery The wrapped ProductItemQuery.
protected String	queryString The query string.
protected String	queryType String representation of the query type.
protected int	viewSize The viewSize.

Fields inherited from interface com.beasys.commerce.ebusiness.catalog.rules.CatalogRuleConstants

KEYWORD_QUERY, PRODUCT_ITEM_QUERY

Constructor Summary

CatalogQueryWrapper(String queryType, String queryString, int maxResults, String catalogManagerName, int viewSize)
Constructor with arguments.

Method Summary

String	getCatalogManagerName() Get the value of catalogManagerName.
KeywordQuery	getKeywordQuery() Get the value of keywordQuery.
int	getMaxResults() Get the value of maxResults.
ProductItemQuery	getProductItemQuery() Get the value of productItemQuery.
CatalogQuery	getQuery() Hands out the one query object that this class wraps.
String	getQueryString() Get the value of queryString.
String	getQueryType() Get the value of queryType.
int	getViewSize() Get the value of viewSize.
protected void	setCatalogManagerName(String v) Set the value of catalogManagerName.
protected void	setKeywordQuery(KeywordQuery v) Set the value of keywordQuery.
protected void	setMaxResults(int v) Set the value of maxResults.
protected void	setProductItemQuery(ProductItemQuery v) Set the value of productItemQuery.
protected void	setQueryString(String v) Set the value of queryString.
protected void	setQueryType(String v) Set the value of queryType.
void	setViewSize(int v) Set the value of viewSize.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

keywordQuery

protected KeywordQuery keywordQuery

The wrapped KeywordQuery.

productItemQuery

protected ProductItemQuery productItemQuery

The wrapped ProductItemQuery.

queryType

protected String queryType

String representation of the query type. Helps the rules service let this class know the type of query without the former having to have any knowledge of the nature of the query string. The rules service gets information about the type from the node type in the rule xml.

queryString

protected String queryString

The query string. Could be a space separated list of keywords or a query exrpession.

maxResults

protected int maxResults

The max query results returned.

catalogManagerName

protected String catalogManagerName

The CatalogManagerName. The CatalogManager to use to fire this query.

viewSize

protected int viewSize

The viewSize. This is an optional parameter and if specified will fire a query that returns a ViewIterator over the results. If viewSize is zero an array of productItems will be returned.

Constructor Detail

CatalogQueryWrapper

public CatalogQueryWrapper(String queryType,
                           String queryString,
                           int maxResults,
                           String catalogManagerName,
                           int viewSize)
                    throws InvalidArgumentException

Constructor with arguments.

Parameters

queryType - The type of the query.

queryString - String representation of the query.

Throws

InvalidArgumentException - If there are null arguments.

Method Detail

getKeywordQuery

public KeywordQuery getKeywordQuery()

Get the value of keywordQuery.

Returns

Value of keywordQuery.

setKeywordQuery

protected void setKeywordQuery(KeywordQuery v)

Set the value of keywordQuery.

Parameters

v - Value to assign to keywordQuery.

getProductItemQuery

public ProductItemQuery getProductItemQuery()

Get the value of productItemQuery.

Returns

Value of productItemQuery.

setProductItemQuery

protected void setProductItemQuery(ProductItemQuery v)

Set the value of productItemQuery.

Parameters

v - Value to assign to productItemQuery.

getQueryType

public String getQueryType()

Get the value of queryType.

Returns

Value of queryType.

setQueryType

protected void setQueryType(String v)

Set the value of queryType.

Parameters

v - Value to assign to queryType.

getQueryString

public String getQueryString()

Get the value of queryString.

Returns

Value of queryString.

setQueryString

protected void setQueryString(String v)

Set the value of queryString.

Parameters

v - Value to assign to queryString.

getMaxResults

public int getMaxResults()

Get the value of maxResults.

Returns

Value of maxResults.

setMaxResults

protected void setMaxResults(int v)

Set the value of maxResults.

Parameters

v - Value to assign to maxResults.

getCatalogManagerName

public String getCatalogManagerName()

Get the value of catalogManagerName.

Returns

Value of catalogManagerName.

setCatalogManagerName

protected void setCatalogManagerName(String v)

Set the value of catalogManagerName.

Parameters

v - Value to assign to catalogManagerName.

getViewSize

public int getViewSize()

Get the value of viewSize.

Returns

Value of viewSize.

setViewSize

public void setViewSize(int v)

Set the value of viewSize.

Parameters

v - Value to assign to viewSize.

getQuery

public CatalogQuery getQuery()

Hands out the one query object that this class wraps.

Returns

CatalogQuery The wrapped query object.