public interface

WebThresholdTemplateMetric

implements WebThreshold WebThresholdText
com.microstrategy.web.objects.WebThresholdTemplateMetric

Class Overview

Threshold operations associated with a WebTemplateMetric.

Summary

Public Methods
abstract boolean applyToSubtotals()
Whether the thresholding also applies to subtotals.
abstract String getPrefix()
abstract String getSuffix()
abstract WebTemplateMetric getTemplateMetric()
abstract boolean isDeliveryThreshold()
Returns TRUE if this threshold is a delivery threshold.
abstract void setApplyToSubtotals(boolean applyToSubtotals)
abstract void setIsDelivery(boolean isDelivery)
Sets a threshold to be a delivery threshold that is used for alerting.
abstract void setPrefix(String prefix)
abstract void setSuffix(String suffix)
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebThreshold
From interface com.microstrategy.web.objects.WebThresholdText

Public Methods

public abstract boolean applyToSubtotals ()

Whether the thresholding also applies to subtotals. By default this is false.

Returns
  • whether the thresholding also applies to subtotals.

public abstract String getPrefix ()

Returns
  • prepends this prefix to the metric iff the thresholding conditions are met.

public abstract String getSuffix ()

Returns
  • appends this suffix to the metric iff the thresholding conditions are met.

public abstract WebTemplateMetric getTemplateMetric ()

Returns
  • the associated template metric.

public abstract boolean isDeliveryThreshold ()

Returns TRUE if this threshold is a delivery threshold. A delivery threshold is a special type of threshold that is used to build an 'alert' for subscriptions.

public abstract void setApplyToSubtotals (boolean applyToSubtotals)

Parameters
applyToSubtotals whether the thresholding also applies to subtotals.

public abstract void setIsDelivery (boolean isDelivery)

Sets a threshold to be a delivery threshold that is used for alerting.

public abstract void setPrefix (String prefix)

Parameters
prefix prepends this prefix to the metric iff the thresholding conditions are met.

public abstract void setSuffix (String suffix)

Parameters
suffix appends this suffix to the metric iff the thresholding conditions are met.