|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.servlet.jsp.tagext.TagSupport com.bea.p13n.servlets.jsp.TagSupport com.bea.p13n.servlets.jsp.taglib.ContentTagSupport com.bea.p13n.servlets.jsp.taglib.ContentSelectorTag
public class ContentSelectorTag
The tag handler of the personalization jsp extension tag 'contentSelector'. The contentSelector tag allows arbitrary personalized content to be selected based on user profile.
Field Summary | |
---|---|
protected String |
appendQuery
The query appended on to the end of the content selector query. |
protected String |
home
Deprecated No longer used. |
protected String |
id
To store the value of id attribute. |
protected long |
max
Limits the number of content items returned. |
protected String |
query
A content query string that can be appended as an 'and' phrase to the content query in the contentSelector rule. |
protected String |
selector
The name of the selector rule in the rule set. |
protected String |
sortBy
A list of document attributes to sort the content by. |
Fields inherited from class com.bea.p13n.servlets.jsp.taglib.ContentTagSupport |
---|
cacheId, cacheScope, cacheTimeout, contextParams, searchPaths, useCache, versionedContent |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
pageContext |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
---|
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
---|---|
ContentSelectorTag()
|
Method Summary | |
---|---|
int |
doStartTag()
Processes the start tag. |
String |
getAppendQuery()
Gets the appendQuery that is added to the content selector query. |
String |
getContentHome()
Deprecated No longer used. |
protected Node[] |
getDocuments()
Get the array of content documents. |
String |
getId()
Gets the id to assign the results to. |
String |
getMax()
The the max number of content items returned. |
String |
getQuery()
Get the content query string that can be appended as an 'and' phrase to the content query in the contentSelector rule. |
protected AdviceRequest |
getRequest()
Returns a ContentSelector 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 CONTENT_QUERY_STRING A CONTENT_QUERY_MAX_ITEMS A CONTENT_QUERY_SORT_BY A RULES_RULENAME_TO_FIRE A RULES_FILTER_CLASS_NAME |
String |
getRule()
Get name of the selector rule in the ruleSet. |
String |
getSortBy()
Gets the list of document attributes to sort the content by. |
protected Version[] |
getVersionedDocuments()
Get the array of content documents. |
void |
release()
Reinitializes the instance data in this object. |
void |
setAppendQuery(String anAppendQuery)
Sets the appendQuery to add to the content selector query. |
void |
setContentHome(String aHome)
Deprecated No longer used. |
void |
setId(String anId)
Sets the id to assign the results to. |
void |
setMax(long max)
Sets the max number of content items returned. |
void |
setMax(String aNumber)
Sets the max number of content items returned. |
void |
setQuery(String aQuery)
Sets the content query string that can be appended as an 'and' phrase to the content query in the contentSelector rule. |
void |
setRule(String aSelector)
Set name of the selector rule in the rule set. |
void |
setSortBy(String anOrderbyClause)
Sets the list of document attributes to sort the content by. |
Methods inherited from class com.bea.p13n.servlets.jsp.taglib.ContentTagSupport |
---|
checkContentCache, getCacheId, getCacheScope, getCacheTimeout, getContextParams, getSearchPaths, getUseCache, getVersionedContent, initRepositoryManager, secureContentResults, secureContentResults, setCacheId, setCacheScope, setCacheTimeout, setCacheTimeout, setContextParams, setContextParams, setInContentCache, setSearchPaths, setSearchPaths, setUseCache, setUseCache, setVersionedContent |
Methods inherited from class com.bea.p13n.servlets.jsp.TagSupport |
---|
createAdviceRequest, createAdvisor |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected String selector
protected long max
protected String sortBy
protected String query
protected String home
protected String id
protected String appendQuery
Constructor Detail |
---|
public ContentSelectorTag()
Method Detail |
---|
public void setRule(String aSelector)
aSelector
- The name of the selector rule.public String getRule()
public String getMax()
public void setMax(String aNumber)
aNumber
- String representing a number. If it isn't a
number, max is left at the default.public void setMax(long max)
max
- A long that represents the max number of content
items that can be returned.public void setSortBy(String anOrderbyClause)
anOrderbyClause
- The order by clause to use to sort the results.public String getSortBy()
public void setQuery(String aQuery)
aQuery
- The query string to append.public String getQuery()
public void setContentHome(String aHome)
aHome
- The home name of the content manager bean.public String getContentHome()
public void setId(String anId)
setId
in class javax.servlet.jsp.tagext.TagSupport
anId
- The id for the results.public String getId()
getId
in class javax.servlet.jsp.tagext.TagSupport
public void setAppendQuery(String anAppendQuery)
anAppendQuery
- public String getAppendQuery()
protected Node[] getDocuments() throws JspException
JspException
- If unable to get advice or if incomplete advice is received.protected Version[] getVersionedDocuments() throws JspException
JspException
- If unable to get advice or if incomplete advice is received.protected AdviceRequest getRequest() throws JspException
JspException
- If there is a problem creating the request.public int doStartTag() throws JspException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.TagSupport
JspException
- if an error.
occurrs during content retrieval.public void release()
release
in interface javax.servlet.jsp.tagext.Tag
release
in class ContentTagSupport
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |