Package com.microstrategy.web.objects

Interface WebThreshold

All Known Subinterfaces:

RWThreshold, RWThresholdText, WebThresholdTemplateAttribute, WebThresholdTemplateMetric

public interface WebThreshold

Defines operations on a threshold.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
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
WebObjectInfo	getDataSetObj()	The WebObjectInfo on the linked dataSetInfo.
WebExpression	getExpression()	Returns the WebExpression associated with the threshold.
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
WebFormat	getFormat()	Returns the WebFormat object associated with the threshold, which can be used to modify the format associated with the threshold.
java.lang.String	getId()	Returns the ID of the threshold.
java.lang.String	getName()	Returns the name of the threshold.
java.lang.String	getReplaceText()	Returns the text used to replace the actual value iff threshold condition is met.
int	getReplaceType()	Returns the semantics value from EnumDSSXMLBaseFormType that is used to define the kind of replace text.
int	getScope()
WebObjectInfo	getTarget()	The WebObjectInfo on which the threshold is based on.
int	getThresholdAction()
int	getThresholdType()	Returns the type of the threshold, from EnumThresholdTypes.
boolean	isEnabled()	Returns whether the threshold is enabled or not.
boolean	isReplaceTypeDefined()	Indicates whether the replace text is one of the following types EnumDSSXMLBaseFormType.DssXmlBaseFormText EnumDSSXMLBaseFormType.DssXmlBaseFormSymbol EnumDSSXMLBaseFormType.DssXmlBaseFormPicture
boolean	isTransaction()
void	setEnabled(boolean enable)	Sets the enabled flag of the threshold.
void	setName(java.lang.String newName)	Sets the name of the threshold.
void	setScope(int scope)
void	setThresholdAction(java.lang.String action)

Method Detail

getFormat

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.

isEnabled

boolean isEnabled()

Returns whether the threshold is enabled or not.

Returns:

True if the threshold is enabled, false otherwise.

setEnabled

void setEnabled(boolean enable)

Sets the enabled flag of the threshold.

Parameters:

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

getExpression

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.

setName

void setName(java.lang.String newName)

Sets the name of the threshold.

Parameters:

newName - The new name to use for the threshold.

getName

java.lang.String getName()

Returns the name of the threshold.

Returns:

The current name of the threshold.

getId

java.lang.String getId()

Returns the ID of the threshold.

Returns:

The ID of the threshold.

getThresholdType

int getThresholdType()

Returns the type of the threshold, from EnumThresholdTypes.

Returns:

The type, from EnumThresholdTypes.

isReplaceTypeDefined

boolean isReplaceTypeDefined()

Indicates whether the replace text is one of the following types

• EnumDSSXMLBaseFormType.DssXmlBaseFormText
• EnumDSSXMLBaseFormType.DssXmlBaseFormSymbol
• EnumDSSXMLBaseFormType.DssXmlBaseFormPicture

getFloor

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

getCeiling

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

getTarget

WebObjectInfo getTarget()

The WebObjectInfo on which the threshold is based on.

getDataSetObj

WebObjectInfo getDataSetObj()

The WebObjectInfo on the linked dataSetInfo.

getReplaceType

int getReplaceType()

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

Returns:

semantics value from EnumDSSXMLBaseFormType.

getReplaceText

java.lang.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.

getScope

int getScope()

Returns:

threshold scope EnumDSSXMLThresholdScope

setScope

void setScope(int scope)

Parameters:

scope - sets scope EnumDSSXMLThresholdScope

setThresholdAction

void setThresholdAction(java.lang.String action)

Parameters:

newAction - sets action EnumDSSXMLTransactionAction

getThresholdAction

int getThresholdAction()

Returns:

threshold action EnumDSSXMLTransactionAction

isTransaction

boolean isTransaction()

Returns:

whether this threshold is transaction threshold