Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

ThresholdEditorBean

implements Persistable ReportFrameElement ViewBeanParserBean

com.microstrategy.web.app.beans.ThresholdEditorBean

Known Indirect Subclasses

AlertsEditorBean

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 using`setCurrentContainerKey(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(String key) This method will return the thresholds type, from `EnumThresholdTypes`, of the thresholds collection associated with the given 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 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

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.app.beans.FrameElement

abstract FrameBean	getFrameBean() Returns the frame bean that is containing this FrameElement.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
abstract boolean	isEditor() Indicates whether a ReportFrameElement most be considered editor.
abstract boolean	isEnabled() Indicates whether a ReportFrameElement is Enabled.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output

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

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

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

The ExpressionDisplayBean that is a child of this bean.

public abstract ThresholdExpressionBean getExpressionEditorBean ()

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

Returns

The ThresholdExpressionBean that is a child of this bean.

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 ()

Throws

WebBeanException
WebObjectsException

public abstract WebTemplateMetrics getTemplateMetrics ()

Throws

WebBeanException
WebObjectsException

public abstract WebThresholds getThresholds ()

Retrieves thresholds corresponding to the current active container.

Returns

A SimpleList collection of WebAppSimpleThreshold objects

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 (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 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 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.

Interfaces

Classes

Exceptions

ThresholdEditorBean

Class Overview

Summary

Public Methods

public abstract void applyChanges ()

public abstract void clearThresholdCopies ()

public abstract boolean getAllowToggleThresholds ()

Throws

public abstract Enumeration getAttributesList ()

public abstract boolean getAutoApply ()

Returns

public abstract WebThresholdsContainer getContainer ()

Returns

public abstract WebThresholdsContainer getContainerFromKey (String key)

public abstract String getCopyContainerKey ()

Returns

public abstract String getCopyThresholdID ()

Returns

public abstract String getCurrentContainerKey ()

Returns

public abstract String getCurrentRangeBoundaries ()

Returns

public abstract String getCurrentThresholdID ()

public abstract RWDataSet getDataSet ()

public abstract ExpressionDisplayBean getDisplayExpressionBean ()

Returns

public abstract ThresholdExpressionBean getExpressionEditorBean ()

Returns

public abstract String getExpressionEditorThresholdID ()

Returns

public abstract Enumeration getMetricsList ()

public abstract Enumeration getMetricsListWithDataSetInfo (List dataSetList)

public abstract boolean getShowLabels ()

Returns

public abstract WebTemplateAttributes getTemplateAttributes ()

Throws

public abstract WebTemplateMetrics getTemplateMetrics ()

Throws

public abstract WebThresholds getThresholds ()

Returns

public abstract WebThresholds getThresholdsByKey (String key)

Parameters

public abstract int getThresholdsType (String key)

Returns

public abstract int getThresholdsType ()

Returns

public abstract WebWorkingSet getWorkingSet ()

public abstract boolean isConditionalFormatting ()

Returns

public abstract void resetChanges ()

public abstract void setAllowToggleThresholds (boolean value)

Throws

public abstract void setAutoApply (boolean value)

Parameters

public abstract void setCurrentContainerKey (String id)

Parameters

public abstract void setCurrentRangeBoundaries (String value)

Parameters

public abstract void setCurrentThresholdID (String thresholdID)

public abstract void setExpressionEditorThresholdID (String thresholdID)

Parameters

public abstract void setShowLabels (boolean value)

Parameters