CatalogQueryTag Class

com.beasys.commerce.ebusiness.catalog.tags
CatalogQueryTag Class

public class CatalogQueryTag

    extends TagSupport
    implements AdviceConstants, AdviceRequestConstants, CatalogRuleConstants

The tag handler of the catalogQuery. The catalogQuery tag allows arbitrary personalized content to be selected based on a catalog query.

Hierarchy
Object
  TagSupport
    CatalogQueryTag
All Implemented Interfaces

AdviceConstants, AdviceRequestConstants, CatalogRuleConstants, IterationTag, Serializable, Tag

Field Summary
public String
catalogManagerName
The CatalogManagerName to use for querying.
public String
expression
The expression for an expression search.
public String
id
The identifier that holds the results of the CatalogQuery.
public String
keywords
The keywords for a keyword query.
public int
maxResults
The maximum number of results to return.
public int
viewSize
View size in the ViewIterator.
   
Fields from  javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields from interface com.bea.p13n.advisor.AdviceConstants
RESULTS
 
Fields from interface com.bea.p13n.advisor.AdviceRequestConstants
CATALOG_QUERY_WRAPPER, CONTENT_APPEND_QUERY_STRING, CONTENT_MANAGER, CONTENT_MANAGER_HOME, CONTENT_QUERY_CONTEXT_PARAMS, CONTENT_QUERY_MAX_ITEMS, CONTENT_QUERY_NODE, CONTENT_QUERY_SORT_BY, CONTENT_QUERY_STRING, DATE, HTTP_REQUEST, HTTP_SESSION, NOW, RULES_FILTER_CLASS, RULES_FILTER_CLASS_NAME, RULES_INPUT_OBJECTS, RULES_RULENAME_TO_FIRE, RULES_RULESET_NAME, SHOPPING_CART, TIME, TIME_INSTANT, USER
 
Fields from interface com.beasys.commerce.ebusiness.catalog.rules.CatalogRuleConstants
KEYWORD_QUERY, PRODUCT_ITEM_QUERY
 
Fields from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 

Constructor Summary
CatalogQueryTag()
 

Method Summary
public int
doStartTag()
Processes the start tag.
public String
getCatalogManagerName()
Get the value of catalogManagerName.
public String
getExpression()
Get the value of expression.
public String
getId()
Get the value of id.
protected ViewIterator
getItems()
Get a ViewIterator over catalog items.
public String
getKeywords()
Get the value of keywords.
public int
getMaxResults()
Get the value of maxResults.
public int
getViewSize()
Get the value of viewSize.
public void
release()
Clean up.
public void
setCatalogManagerName(String v)
Set the value of catalogManagerName.
public void
setExpression(String v)
Set the value of expression.
public void
setId(String v)
Set the value of id.
public void
setKeywords(String v)
Set the value of keywords.
public void
setMaxResults(int v)
Set the value of maxResults.
public void
setViewSize(int v)
Set the value of viewSize.
 
Methods from  javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface javax.servlet.jsp.tagext.IterationTag
doAfterBody
 
Methods from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, release, setPageContext, setParent
 

Field Detail

catalogManagerName

public String catalogManagerName
The CatalogManagerName to use for querying.

expression

public String expression
The expression for an expression search.

id

public String id
The identifier that holds the results of the CatalogQuery.

keywords

public String keywords
The keywords for a keyword query.

maxResults

public int maxResults
The maximum number of results to return.

viewSize

public int viewSize
View size in the ViewIterator.

 

Constructor Detail

CatalogQueryTag

public CatalogQueryTag()
 

Method Detail

doStartTag() Method

public int doStartTag()
     throws JspException
Processes the start tag.

Overrides
TagSupport.doStartTag()

Returns

The SKIP_BODY constant since this tag does not have a body.

Exceptions

JspException

getCatalogManagerName() Method

public String getCatalogManagerName()
Get the value of catalogManagerName.

Returns

Value of catalogManagerName.

getExpression() Method

public String getExpression()
Get the value of expression.

Returns

Value of expression.

getId() Method

public String getId()
Get the value of id.

Overrides
TagSupport.getId()

Returns

Value of id.

getItems() Method

protected ViewIterator getItems()
     throws JspTagException
Get a ViewIterator over catalog items.

Returns

ViewIterator.

Exceptions

JspTagException

getKeywords() Method

public String getKeywords()
Get the value of keywords.

Returns

Value of keywords.

getMaxResults() Method

public int getMaxResults()
Get the value of maxResults.

Returns

Value of maxResults.

getViewSize() Method

public int getViewSize()
Get the value of viewSize.

Returns

Value of viewSize.

release() Method

public void release()
Clean up.

Overrides
TagSupport.release()

setCatalogManagerName(String) Method

public void setCatalogManagerName(String v)
Set the value of catalogManagerName.

Parameters

v
Value to assign to catalogManagerName.

setExpression(String) Method

public void setExpression(String v)
Set the value of expression.

Parameters

v
Value to assign to expression.

setId(String) Method

public void setId(String v)
Set the value of id.

Overrides
TagSupport.setId(String)

Parameters

v
Value to assign to id.

setKeywords(String) Method

public void setKeywords(String v)
Set the value of keywords.

Parameters

v
Value to assign to keywords.

setMaxResults(int) Method

public void setMaxResults(int v)
Set the value of maxResults.

Parameters

v
Value to assign to maxResults.

setViewSize(int) Method

public void setViewSize(int v)
Set the value of viewSize.

Parameters

v
Value to assign to viewSize.