public interface

ThresholdEditorBean

implements Persistable ReportFrameElement ViewBeanParserBean
com.microstrategy.web.app.beans.ThresholdEditorBean
Known Indirect Subclasses

Class Overview

The ThresholdEditorBean is a bean which can be used to render a threshold editor. Note that this bean exposes copies of the original thresholds - in order for the changes made to those copies to take effect, the applyChanges method must be called.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract void applyChanges()
Applies all changes made to the threshold editor bean to the underlying thresholds object.
abstract void clearThresholdCopies()
abstract boolean getAllowToggleThresholds()
This method can be used to toggle whether the user is allowed to toggle the thresholds in the report.
abstract Enumeration getAttributesList()
Returns a list of attributes that are considered to be available to the user for editing the threshold.
abstract boolean getAutoApply()
Returns whether to apply each change in the editor as it happens.
abstract WebThresholdsContainer getContainer()
Retrieves the active container that was set usingsetCurrentContainerKey(String)
abstract WebThresholdsContainer getContainerFromKey(String key)
abstract String getCopyContainerKey()
Returns the current container key that the user has selected for the "copy" operation.
abstract String getCopyThresholdID()
Returns the current threshold ID that the user has selected for the "copy" operation.
abstract String getCurrentContainerKey()
Returns the id of the currently selected container.
abstract String getCurrentRangeBoundaries()
Returns the current range boundary of the threshold.
abstract String getCurrentThresholdID()
Returns the currently selected threshold ID.
abstract RWDataSet getDataSet()
abstract ExpressionDisplayBean getDisplayExpressionBean()
Returns the child ExpressionDisplayBean, which can be used to display subexpressions that are not being edited.
abstract ThresholdExpressionBean getExpressionEditorBean()
Returns the child ThresholdExpressionBean, which is used to display and edit a single subexpression chosen by the user.
abstract String getExpressionEditorThresholdID()
Returns the ID of the threshold that the ThresholdExpressionBean is currently set to work on.
abstract Enumeration getMetricsList()
Returns a list of metrics that are considered to be available to the user for editing the threshold.
abstract Enumeration getMetricsListWithDataSetInfo(List dataSetList)
Returns a list of metrics that are considered to be available to the user for editing the threshold.
abstract boolean getShowLabels()
Returns whether to show all value labels in the editor
abstract WebTemplateAttributes getTemplateAttributes()
abstract WebTemplateMetrics getTemplateMetrics()
abstract WebThresholds getThresholds()
Retrieves thresholds corresponding to the current active container.
abstract WebThresholds getThresholdsByKey(String key)
This method can be used to get the WebThresholds object corresponding to a specific container key.
abstract int getThresholdsType()
Returns the type of the thresholds defined on the currently active container The type corresponds to a value from EnumThresholdTypes.
abstract int getThresholdsType(String key)
This method will return the thresholds type, from EnumThresholdTypes, of the thresholds collection associated with the given container key.
abstract WebWorkingSet getWorkingSet()
abstract boolean isConditionalFormatting()
Returns true if we are editing threshold definition on the document field.
abstract void resetChanges()
This method removes all changes made to the threshold editor bean, effectively setting it back to the state it was in before doing any edits.
abstract void setAllowToggleThresholds(boolean value)
This method can be used to toggle whether the user is allowed to toggle the thresholds in the report.
abstract void setAutoApply(boolean value)
Sets whether to apply each change in the editor as it happens.
abstract void setCurrentContainerKey(String id)
Sets the id of the currently selected thresholds container in the editor
abstract void setCurrentRangeBoundaries(String value)
Sets the current range boundary of the threshold.
abstract void setCurrentThresholdID(String thresholdID)
Sets the currently selected threshold ID.
abstract void setExpressionEditorThresholdID(String thresholdID)
Sets the ID of the threshold that the ThresholdExpressionBean is currently set to work on.
abstract void setShowLabels(boolean value)
Sets whether to show all value labels in the editor.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract void applyChanges ()

Applies all changes made to the threshold editor bean to the underlying thresholds object.

public abstract void clearThresholdCopies ()

public abstract boolean getAllowToggleThresholds ()

This method can be used to toggle whether the user is allowed to toggle the thresholds in the report.

Throws
WebBeanException Thrown if an error occurs when setting the value.

public abstract Enumeration getAttributesList ()

Returns a list of attributes that are considered to be available to the user for editing the threshold.

public abstract boolean getAutoApply ()

Returns whether to apply each change in the editor as it happens. This is meant as a hint to the GUI - this will have no effect on the actual behavior of the bean.

Returns
  • boolean The current value of the auto-apply setting.

public abstract WebThresholdsContainer getContainer ()

Retrieves the active container that was set usingsetCurrentContainerKey(String)

Returns
  • The active metric. Note that the collection of thresholds returned from here will NOT reflect any changes made to the bean state that have not been propagated back to the report instance.

public abstract WebThresholdsContainer getContainerFromKey (String key)

public abstract String getCopyContainerKey ()

Returns the current container key that the user has selected for the "copy" operation.

Returns
  • The current copy container key.

public abstract String getCopyThresholdID ()

Returns the current threshold ID that the user has selected for the "copy" operation.

Returns
  • The copy threshold ID.

public abstract String getCurrentContainerKey ()

Returns the id of the currently selected container.

Returns
  • The current container ID.

public abstract String getCurrentRangeBoundaries ()

Returns the current range boundary of the threshold.

Returns
  • The current setting for the range boundary.

public abstract String getCurrentThresholdID ()

Returns the currently selected threshold ID.

public abstract RWDataSet getDataSet ()

public abstract ExpressionDisplayBean getDisplayExpressionBean ()

Returns the child ExpressionDisplayBean, which can be used to display subexpressions that are not being edited.

Returns

public abstract ThresholdExpressionBean getExpressionEditorBean ()

Returns the child ThresholdExpressionBean, which is used to display and edit a single subexpression chosen by the user.

Returns

public abstract String getExpressionEditorThresholdID ()

Returns the ID of the threshold that the ThresholdExpressionBean is currently set to work on. This must be set because there exists only one expression editing bean for all expressions, and so that bean must be made aware of which expression is being edited.

Returns
  • The current id of the expression editor's focus.

public abstract Enumeration getMetricsList ()

Returns a list of metrics that are considered to be available to the user for editing the threshold.

public abstract Enumeration getMetricsListWithDataSetInfo (List dataSetList)

Returns a list of metrics that are considered to be available to the user for editing the threshold. And also store the related dataset id in the parameter list

public abstract boolean getShowLabels ()

Returns whether to show all value labels in the editor

Returns
  • boolean The current setting of the show all labels parameter.

public abstract WebTemplateAttributes getTemplateAttributes ()

public abstract WebTemplateMetrics getTemplateMetrics ()

public abstract WebThresholds getThresholds ()

Retrieves thresholds corresponding to the current active container.

Returns

public abstract WebThresholds getThresholdsByKey (String key)

This method can be used to get the WebThresholds object corresponding to a specific container key.

Parameters
key The container key of the thresholds object to obtain.

public abstract int getThresholdsType ()

Returns the type of the thresholds defined on the currently active container The type corresponds to a value from EnumThresholdTypes. All the thresholds for this active container need to be of the same type in order for this method to return a proper type. If at least one of the thresholds is of a different type, then TYPE_COMPLEX is returned

Returns
  • The thresholds type of the currently selected threshold container.

public abstract int getThresholdsType (String key)

This method will return the thresholds type, from EnumThresholdTypes, of the thresholds collection associated with the given container key.

Returns
  • The thresholds type of the thresholds collection associated with the given key, from EnumThresholdTypes.

public abstract WebWorkingSet getWorkingSet ()

public abstract boolean isConditionalFormatting ()

Returns true if we are editing threshold definition on the document field.

Returns
  • true if we are editing threshold definition on the document field.

public abstract void resetChanges ()

This method removes all changes made to the threshold editor bean, effectively setting it back to the state it was in before doing any edits.

public abstract void setAllowToggleThresholds (boolean value)

This method can be used to toggle whether the user is allowed to toggle the thresholds in the report.

Throws
WebBeanException Thrown if an error occurs when setting the value.

public abstract void setAutoApply (boolean value)

Sets whether to apply each change in the editor as it happens. This is meant as a hint to the GUI - this will have no effect on the actual behavior of the bean.

Parameters
value The new value of the auto-apply setting.

public abstract void setCurrentContainerKey (String id)

Sets the id of the currently selected thresholds container in the editor

Parameters
id The current container ID.

public abstract void setCurrentRangeBoundaries (String value)

Sets the current range boundary of the threshold.

Parameters
value The new value for the range boundary.

public abstract void setCurrentThresholdID (String thresholdID)

Sets the currently selected threshold ID.

public abstract void setExpressionEditorThresholdID (String thresholdID)

Sets the ID of the threshold that the ThresholdExpressionBean is currently set to work on. This must be done because there exists only one expression editing bean for all expressions.

Parameters
thresholdID The threshold ID of the expression editor's focus.

public abstract void setShowLabels (boolean value)

Sets whether to show all value labels in the editor.

Parameters
value The new value of the setting.