public class

ErrorMessageTag

extends ResponseContextTag
java.lang.Object
   ↳ TagSupport
     ↳ com.microstrategy.web.app.taglibs.taskproc.ResponseContextTag
       ↳ com.microstrategy.web.app.taglibs.taskproc.ErrorMessageTag

Summary

Public Constructors
ErrorMessageTag()
Public Methods
ResponseContextTagHelper getHelper()
Method for retrieving the helper related with the tag.
void setAttrName(String attrName)
Specifies an XML attribute name to use when formatting the error message into an XML document.
void setEncode(String encode)
Specifies a type of encoding to perform on the error message.
void setMatchStr(String matchStr)
Specifies an optional string it is searched for in the error message.
void setReplaceStr(String replaceStr)
Specifies an a "replacement string" to use in the error message.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.taglibs.taskproc.ResponseContextTag
From class java.lang.Object

Public Constructors

public ErrorMessageTag ()

Public Methods

public ResponseContextTagHelper getHelper ()

Method for retrieving the helper related with the tag.

Returns
  • an instance from ResponseContextTagHelper which takes care of processing and rendering the HTML contents related with this tag.

public void setAttrName (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

public void setEncode (String encode)

Specifies a type of encoding to perform on the error message. Possible values include: json, xml or html. 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.

public void setMatchStr (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.

public void setReplaceStr (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.