CatalogSelectorTag Class

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

public class CatalogSelectorTag

    extends TagSupport

The tag handler of the catalog jsp extension tag 'catalogSelector'. The catalogtSelector tag allows personalized catalog items to be selected based on user profile.


Hierarchy
Object
  TagSupport
    TagSupport
      CatalogSelectorTag
All Implemented Interfaces

IterationTag, Serializable, Tag

Field Summary

protected String
id
To store the value of id attribute.
protected String
selector
The name of the selector rule in the rule set.
   
Fields from  javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
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

CatalogSelectorTag()

 

Method Summary

public int
doStartTag()
Processes the start tag.
protected ViewIterator
getCatalogItems()
Get the ViewIterator over catalog items.
public String
getId()
Gets the id to assign the results to.
protected AdviceRequest
getRequest()
Returns a CatalogSelector AdviceRequest object after populating the following fields
  • The current HTTP Request
  • The current HTTP Session
  • The current User
  • A new TimeInstant
  • A new Time
  • A new Date
  • A RULES_RULENAME_TO_FIRE
  • A RULES_FILTER_CLASS_NAME
public String
getRule()
Get name of the selector rule in the ruleSet.
public void
release()
Reinitializes the instance data in this object.
public void
setId(String anId)
Sets the id to assign the results to.
public void
setRule(String aSelector)
Set name of the selector rule in the rule set.
 
Methods from  com.bea.p13n.servlets.jsp.TagSupport
createAdviceRequest, createAdvisor
 
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

id

protected String id
To store the value of id attribute.


selector

protected String selector
The name of the selector rule in the rule set.

 

Constructor Detail

CatalogSelectorTag

public CatalogSelectorTag()
 

Method Detail

doStartTag() Method

public int doStartTag()
throws JspException
Processes the start tag. Will set the 'id' to array of content objects found.

Overrides
TagSupport.doStartTag()

Returns

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

Exceptions

JspException
if an error. occurrs during content retrieval.

getCatalogItems() Method

protected ViewIterator getCatalogItems()
throws JspException
Get the ViewIterator over catalog items.

Returns

a ViewIterator over the CatalogItems.

Exceptions

JspException
If unable to get advice or if incomplete advice is received.

getId() Method

public String getId()
Gets the id to assign the results to.

Overrides
TagSupport.getId()

Returns

The id for the results.

getRequest() Method

protected AdviceRequest getRequest()
throws JspException
Returns a CatalogSelector AdviceRequest object after populating the following fields

Returns

A CatalogSelector AdviceRequest.

Exceptions

JspException
If there is a problem creating the request.

getRule() Method

public String getRule()
Get name of the selector rule in the ruleSet.

Returns

String The name of the selector rule.

release() Method

public void release()
Reinitializes the instance data in this object.

Overrides
TagSupport.release()

setId(String) Method

public void setId(String anId)
Sets the id to assign the results to.

Overrides
TagSupport.setId(String)

Parameters

anId
The id for the results.

setRule(String) Method

public void setRule(String aSelector)
Set name of the selector rule in the rule set.

Parameters

aSelector
The name of the selector rule.