LoggingTag (Web API 2021)

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - com.microstrategy.web.app.taglibs.AbstractNoBodyTag
  - - com.microstrategy.web.app.taglibs.LoggingTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
```
public class LoggingTag
extends AbstractNoBodyTag
```
Since:

MicroStrategy Web 7.3.1 or earlier

See Also:

Serialized Form

Field Summary
- Fields inherited from class javax.servlet.jsp.tagext.TagSupport
  id, 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

Constructors
Constructor Description

LoggingTag()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AbstractNoBodyTagHelper`	`getHelper()`	Method for retrieving the helper associated with the tag.
`void`	`setAction(java.lang.String value)`	Indicates the type of action that will determine the content to display.
`void`	`setDisplayMode(java.lang.String value)`	set the display mode used as the DisplayGuiComponent renders
`void`	`setNames(java.lang.String value)`	Indicates the names of all the components that were analized by the page (separated by commas).
`void`	`setTimes(java.lang.String value)`	Indicates the times recorded for each one of the components included on the names attribute (in the same order, separated by commas).
`void`	`setUrl(java.lang.String value)`	Indicates the url that is being analyzed by the logging architecture.
`void`	`setUrlObjId(java.lang.String value)`	Indicates the identifier for the url, in the case of an automated test that hits the different url pages several times.

Methods inherited from class com.microstrategy.web.app.taglibs.AbstractNoBodyTag
doEndTag, doStartTag, release

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, 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

- Constructor Detail
  - LoggingTag
```
public LoggingTag()
```
- Method Detail
  - getHelper
```
public AbstractNoBodyTagHelper getHelper()
```
    Method for retrieving the helper associated with the tag.
    
    Specified by:
    
    getHelper in class AbstractNoBodyTag
    
    Returns:
    
    an instance of AbstractNoBodyTagHelper which will take care of processing and rendering the HTML contents related with this tag.
  - setAction
```
public void setAction(java.lang.String value)
```
    Indicates the type of action that will determine the content to display.
    Usage:
    Possible action values include:
  - logTimes - Generates the code for allowing the page the client rendering times will be logged.
  - statistics - Displays the statistics information gathered from the page.
  - reset - Sets the page to an empty location.
  - results - Renders in a table the information gathered from the page that was just executed.
  - init - Initializes the logging statistics module.

Parameters:: value - String

setUrl
```
public void setUrl(java.lang.String value)
```
Indicates the url that is being analyzed by the logging architecture.

Parameters:

value - String with the url information being analyzed.

setUrlObjId
```
public void setUrlObjId(java.lang.String value)
```
Indicates the identifier for the url, in the case of an automated test that hits the different url pages several times.

Parameters:

value - String with the identifier for the url analyzed.

setNames
```
public void setNames(java.lang.String value)
```
Indicates the names of all the components that were analized by the page (separated by commas).

Parameters:

value - String with the names of the components analyzed.

setTimes
```
public void setTimes(java.lang.String value)
```
Indicates the times recorded for each one of the components included on the names attribute (in the same order, separated by commas).

Parameters:

value - String information about the times for each one of the components being analyzed.

setDisplayMode
```
public void setDisplayMode(java.lang.String value)
```
set the display mode used as the DisplayGuiComponent renders

Parameters:

value - String the display mode: AppContext.DISPLAY_MODE_HTML - plain HTML AppContext.DISPLAY_MODE_JSON - the output will be wrapped up in a json structure in form of {id: id of the component, content: html content to be updated}

Since:

MicroStrategy Web 9.0.1