Class ErrorMessageTag
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagSupport
-
- com.microstrategy.web.app.taglibs.taskproc.ResponseContextTag
-
- com.microstrategy.web.app.taglibs.taskproc.ErrorMessageTag
-
- All Implemented Interfaces:
java.io.Serializable
,javax.servlet.jsp.tagext.IterationTag
,javax.servlet.jsp.tagext.JspTag
,javax.servlet.jsp.tagext.Tag
public class ErrorMessageTag extends ResponseContextTag
- Since:
- MicroStrategy Web 8.1.0
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ErrorMessageTag()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ResponseContextTagHelper
getHelper()
Method for retrieving the helper related with the tag.void
setAttrName(java.lang.String attrName)
Specifies an XML attribute name to use when formatting the error message into an XML document.void
setEncode(java.lang.String encode)
Specifies a type of encoding to perform on the error message.void
setMatchStr(java.lang.String matchStr)
Specifies an optional string it is searched for in the error message.void
setReplaceStr(java.lang.String replaceStr)
Specifies an a "replacement string" to use in the error message.-
Methods inherited from class com.microstrategy.web.app.taglibs.taskproc.ResponseContextTag
doEndTag, doStartTag, release
-
-
-
-
Method Detail
-
getHelper
public ResponseContextTagHelper getHelper()
Description copied from class:ResponseContextTag
Method for retrieving the helper related with the tag.- Specified by:
getHelper
in classResponseContextTag
- Returns:
- an instance from
ResponseContextTagHelper
which takes care of processing and rendering the HTML contents related with this tag.
-
setAttrName
public void setAttrName(java.lang.String attrName)
Specifies an XML attribute name to use when formatting the error message into an XML document. When specified, it will generate the following:attrName="ERROR_MESSAGE"
- Parameters:
attrName
- The XML attribute name
-
setMatchStr
public void setMatchStr(java.lang.String matchStr)
Specifies an optional string it is searched for in the error message. If found and the "replace string" is specified, then all occurrences of this string are replaced with the replacement string. This happens before any encoding is performed.- Parameters:
matchStr
- The string to search for in the error message.
-
setReplaceStr
public void setReplaceStr(java.lang.String replaceStr)
Specifies an a "replacement string" to use in the error message. If found and the "match string" is specified, then all occurrences of the "match string" are replaced with this string. This happens before any encoding is performed.- Parameters:
replaceStr
- The string to use for replacing the matched string.
-
setEncode
public void setEncode(java.lang.String encode)
Specifies a type of encoding to perform on the error message. Possible values include:json
,xml
orhtml
. For JSON encoding, we ensure that the error message can appear inside a single quoted string. For XML encoding, we ensure that the error message can appear inside an XML attribute value. For HTML encoding, we ensure html tags are encoded.- Parameters:
encode
- The type of encoding to use.
-
-