Package com.microstrategy.web.objects
Interface WebThresholdTemplateAttribute
-
- All Superinterfaces:
WebThreshold
,WebThresholdText
public interface WebThresholdTemplateAttribute extends WebThreshold, WebThresholdText
Threshold operations associated with aWebTemplateAttribute
.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
applyToSubtotals()
Whether the thresholding also applies to subtotals.java.lang.String
getPrefix()
java.lang.String
getSuffix()
WebTemplateAttribute
getTemplateAttribute()
boolean
isDeliveryThreshold()
ReturnsTRUE
if this threshold is a delivery threshold.void
setApplyToSubtotals(boolean applyToSubtotals)
void
setIsDelivery(boolean isDelivery)
Sets a threshold to be a delivery threshold that is used for alerting.void
setPrefix(java.lang.String prefix)
void
setSuffix(java.lang.String suffix)
-
Methods inherited from interface com.microstrategy.web.objects.WebThreshold
getCeiling, getDataSetObj, getExpression, getFloor, getFormat, getId, getName, getReplaceText, getReplaceType, getScope, getTarget, getThresholdAction, getThresholdType, isEnabled, isReplaceTypeDefined, isTransaction, setEnabled, setName, setScope, setThresholdAction
-
Methods inherited from interface com.microstrategy.web.objects.WebThresholdText
getReplaceText, getTextType, setReplaceText, setTextType
-
-
-
-
Method Detail
-
getPrefix
java.lang.String getPrefix()
- Returns:
- prepends this prefix to the metric iff the thresholding conditions are met.
-
setPrefix
void setPrefix(java.lang.String prefix)
- Parameters:
prefix
- prepends this prefix to the metric iff the thresholding conditions are met.
-
getSuffix
java.lang.String getSuffix()
- Returns:
- appends this suffix to the metric iff the thresholding conditions are met.
-
setSuffix
void setSuffix(java.lang.String suffix)
- Parameters:
suffix
- appends this suffix to the metric iff the thresholding conditions are met.
-
applyToSubtotals
boolean applyToSubtotals()
Whether the thresholding also applies to subtotals. By default this is false.- Returns:
- whether the thresholding also applies to subtotals.
-
setApplyToSubtotals
void setApplyToSubtotals(boolean applyToSubtotals)
- Parameters:
applyToSubtotals
- whether the thresholding also applies to subtotals.
-
getTemplateAttribute
WebTemplateAttribute getTemplateAttribute()
- Returns:
- the associated template metric.
-
isDeliveryThreshold
boolean isDeliveryThreshold()
ReturnsTRUE
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.
-
setIsDelivery
void setIsDelivery(boolean isDelivery)
Sets a threshold to be a delivery threshold that is used for alerting.- Parameters:
isDelivery
-
-
-