Package com.microstrategy.web.app.taglibs

Class IfErrorValueTag

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    public class IfErrorValueTag
extends AbstractIfTag
    Since:
    MicroStrategy Web 7.3.1 or earlier
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

        bodyContent

      • Fields inherited from class javax.servlet.jsp.tagext.TagSupport

        id, pageContext

      • Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

        EVAL_BODY_BUFFERED, EVAL_BODY_TAG

      • 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

      Constructors 
      Constructor Description
      IfErrorValueTag()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AbstractIfTagHelper getHelper()
      Method for retrieving the helper associated with the tag.
      void release()
      Utility method for cleaning up the properties on the custom tag instance.
      void setProperty​(java.lang.String value)
      Indicates the property to look for about the error information.
      void setValue​(java.lang.String value)
      Indicates the value of the code to be compared against the generated exception code value (if existing).

      • Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

        doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

      • Methods inherited from class javax.servlet.jsp.tagext.TagSupport

        findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface javax.servlet.jsp.tagext.Tag

        getParent, setPageContext, setParent

    • Constructor Detail

      • IfErrorValueTag

        public IfErrorValueTag()

    • Method Detail

      • release

        public void release()
        Utility method for cleaning up the properties on the custom tag instance.
        Specified by:
        release in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        release in class javax.servlet.jsp.tagext.BodyTagSupport

      • setProperty

        public void setProperty​(java.lang.String value)
        Indicates the property to look for about the error information.
        Usage:
        The possible values for the properties to analyze include:
      • root evaluates if the exception found in the page has root information that can be obtained from it.
      • contactInfo evaluates if there's an exception on the page and if the application has defined contact information in case of errors.
      • code evaluates if there's an exception and the code it has defined is the same as the one specified on the value attribute of this custom tag. If not specifying the property attribute value, then the tag only evaluates if there's an exception found in the page.
Parameters:
value - String defining the property to search for.

  • setValue

    public void setValue​(java.lang.String value)
    Indicates the value of the code to be compared against the generated exception code value (if existing).
    Usage:
    This attribute is used together with the property attribute if defined as code. The value specified for this attribute will have to match the exception generated code for the custom tag to return True.
    Parameters:
    value - String value with the error code to be used for comparing it against the original exception code.