WebMetric (Web API 2021)

All Superinterfaces:

KeyedObject, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite
```
public interface WebMetric
extends WebObjectInfo
```
The WebMetric interface represents a metric object. It is derived from WebObjectInfo because a metric is a first class object.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getFormula()`	Get the formula of the metric object in the form of an XML
`boolean`	`getIsAllowedHtmlExecution()`	Get the boolean value is the metric allows html execution
`java.lang.String`	`getRootExpressionXML()`	Get the expression of the root of the metric object in the form of an XML
`void`	`setIsAllowedHtmlExecution(int value)`	Set the flag for the metric if the html execution is allowed

Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures
isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo
buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDefaultLanguage, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getTemplateInfo, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDefaultLanguage, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances

- Method Detail
  - getRootExpressionXML
```
java.lang.String getRootExpressionXML()
                               throws WebObjectsException
```
    Get the expression of the root of the metric object in the form of an XML
    
    Returns:
    
    An XML representing the root of the metric object
    
    Throws:
    
    WebObjectsException
  - getFormula
```
java.lang.String getFormula()
```
    Get the formula of the metric object in the form of an XML
    
    Returns:
    
    formula string
  - setIsAllowedHtmlExecution
```
void setIsAllowedHtmlExecution(int value)
```
    Set the flag for the metric if the html execution is allowed
    
    Parameters:
    
    value - int value 1 for true false otherwise
  - getIsAllowedHtmlExecution
```
boolean getIsAllowedHtmlExecution()
```
    Get the boolean value is the metric allows html execution
    
    Returns:
    
    true if html execution is allowed false otherwise