Package com.microstrategy.web.app.taglibs

Class ErrorValueTagHelper

java.lang.Object

com.microstrategy.web.app.taglibs.CoreTagHelper

com.microstrategy.web.app.taglibs.MstrPageTagHelper

com.microstrategy.web.app.taglibs.AbstractNoBodyTagHelper

com.microstrategy.web.app.taglibs.ErrorValueTagHelper

public class ErrorValueTagHelper
extends AbstractNoBodyTagHelper

Helper for the ErrorValueTag tag library.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from class com.microstrategy.web.app.taglibs.MstrPageTagHelper

_mstrPage

Constructor Summary

Constructors

Constructor	Description
ErrorValueTagHelper()

Method Summary

Modifier and Type	Method	Description
void	cleanState()	Resets the state of the tag library, by cleaning the values of the properties initialized for this tag.
MarkupOutput	getContent()	Obtains the contents to render based on the attributes defined (if existing).
void	setDefault(java.lang.String value)	Sets the value assigned to the default attribute of the custom tag instance that uses this helper
void	setExceptionMessage(java.lang.String value)	Sets the exception message that will be used if rendering this property.
void	setExceptionRoot(java.lang.String value)	Sets the root of the exception, so it can be retrieved by the getContent() method.
void	setExceptionStackTrace(java.lang.String value)	Sets the exception stack trace information.
void	setProperty(java.lang.String value)	Sets the value assigned to the property attribute of the custom tag instance that uses this helper

Methods inherited from class com.microstrategy.web.app.taglibs.MstrPageTagHelper

getContainerServices, newHiddenInputBuilder, newURIBuilder, resolveNumericAttribute, setPageComponent

Methods inherited from class com.microstrategy.web.app.taglibs.CoreTagHelper

getTagsFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorValueTagHelper

public ErrorValueTagHelper()

Method Detail

cleanState

public void cleanState()

Resets the state of the tag library, by cleaning the values of the properties initialized for this tag.

Overrides:

cleanState in class MstrPageTagHelper

getContent

public MarkupOutput getContent()
                        throws java.io.IOException

Obtains the contents to render based on the attributes defined (if existing).

Specified by:

getContent in class AbstractNoBodyTagHelper

Returns:

a MarkupOutput instance initialized with the contents to display

Throws:

java.io.IOException - if an error happens while getting the contents to render.

setExceptionMessage

public void setExceptionMessage(java.lang.String value)

Sets the exception message that will be used if rendering this property.

Parameters:

value - String value with the text to display as message, unless the default property is requested.

setExceptionRoot

public void setExceptionRoot(java.lang.String value)

Sets the root of the exception, so it can be retrieved by the getContent() method.

Parameters:

value - String with the root information of the exception.

setExceptionStackTrace

public void setExceptionStackTrace(java.lang.String value)

Sets the exception stack trace information. This information can be retreived by the getContent() method based on the value of the 'property' attribute.

Parameters:

value - String with the stack trace information of the exception.

setProperty

public void setProperty(java.lang.String value)

Sets the value assigned to the property attribute of the custom tag instance that uses this helper

Parameters:

value - String with the name of the property to display.

setDefault

public void setDefault(java.lang.String value)

Sets the value assigned to the default attribute of the custom tag instance that uses this helper

Parameters:

value - String with the descriptor information for the default message to display if requested.