public interface

WebThreshold

com.microstrategy.web.objects.WebThreshold
Known Indirect Subclasses

Class Overview

Defines operations on a threshold.

Summary

Public Methods
abstract double getCeiling()
The value of the upper end of the threshold expression if the threshold corresponds to a non-complex (@link EnumThresholdTypes#TYPE_COMPLEX) type If the threshold type is complex, then -1 is returned
abstract WebObjectInfo getDataSetObj()
The WebObjectInfo on the linked dataSetInfo.
abstract WebExpression getExpression()
Returns the WebExpression associated with the threshold.
abstract double getFloor()
The value of the lower end of the threshold expression if the threshold corresponds to a non-complex (@link EnumThresholdTypes#TYPE_COMPLEX) type If the threshold type is complex, then -1 is returned
abstract WebFormat getFormat()
Returns the WebFormat object associated with the threshold, which can be used to modify the format associated with the threshold.
abstract String getId()
Returns the ID of the threshold.
abstract String getName()
Returns the name of the threshold.
abstract String getReplaceText()
Returns the text used to replace the actual value iff threshold condition is met.
abstract int getReplaceType()
Returns the semantics value from EnumDSSXMLBaseFormType that is used to define the kind of replace text.
abstract int getScope()
abstract WebObjectInfo getTarget()
The WebObjectInfo on which the threshold is based on.
abstract int getThresholdAction()
abstract int getThresholdType()
Returns the type of the threshold, from EnumThresholdTypes.
abstract boolean isEnabled()
Returns whether the threshold is enabled or not.
abstract boolean isReplaceTypeDefined()
Indicates whether the replace text is one of the following types
abstract boolean isTransaction()
abstract void setEnabled(boolean enable)
Sets the enabled flag of the threshold.
abstract void setName(String newName)
Sets the name of the threshold.
abstract void setScope(int scope)
abstract void setThresholdAction(String action)

Public Methods

public abstract double getCeiling ()

The value of the upper end of the threshold expression if the threshold corresponds to a non-complex (@link EnumThresholdTypes#TYPE_COMPLEX) type If the threshold type is complex, then -1 is returned

public abstract WebObjectInfo getDataSetObj ()

The WebObjectInfo on the linked dataSetInfo.

public abstract WebExpression getExpression ()

Returns the WebExpression associated with the threshold. This is the expression that determines when the threshold condition will be applied.

Returns
  • The WebExpression object representing the threshold's condition.

public abstract double getFloor ()

The value of the lower end of the threshold expression if the threshold corresponds to a non-complex (@link EnumThresholdTypes#TYPE_COMPLEX) type If the threshold type is complex, then -1 is returned

public abstract WebFormat getFormat ()

Returns the WebFormat object associated with the threshold, which can be used to modify the format associated with the threshold.

Returns
  • A WebFormat object representing the threshold's format.

public abstract String getId ()

Returns the ID of the threshold.

Returns
  • The ID of the threshold.

public abstract String getName ()

Returns the name of the threshold.

Returns
  • The current name of the threshold.

public abstract String getReplaceText ()

Returns the text used to replace the actual value iff threshold condition is met.

Returns
  • The replace text used if the threshold condition is met.

public abstract int getReplaceType ()

Returns the semantics value from EnumDSSXMLBaseFormType that is used to define the kind of replace text.

Returns

public abstract int getScope ()

Returns

public abstract WebObjectInfo getTarget ()

The WebObjectInfo on which the threshold is based on.

public abstract int getThresholdAction ()

Returns

public abstract int getThresholdType ()

Returns the type of the threshold, from EnumThresholdTypes.

Returns

public abstract boolean isEnabled ()

Returns whether the threshold is enabled or not.

Returns
  • True if the threshold is enabled, false otherwise.

public abstract boolean isReplaceTypeDefined ()

Indicates whether the replace text is one of the following types

public abstract boolean isTransaction ()

Returns
  • whether this threshold is transaction threshold

public abstract void setEnabled (boolean enable)

Sets the enabled flag of the threshold.

Parameters
enable True if the threshold should be enabled, false otherwise.

public abstract void setName (String newName)

Sets the name of the threshold.

Parameters
newName The new name to use for the threshold.

public abstract void setScope (int scope)

Parameters
scope sets scope EnumDSSXMLThresholdScope

public abstract void setThresholdAction (String action)