Package com.microstrategy.web.app.beans
Interface ThresholdEditorBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,FrameElement
,Persistable
,ReportFrameElement
,RequestPersistable
,Transformable
,ViewBeanParserBean
,WebComponent
- All Known Subinterfaces:
AlertsEditorBean
public interface ThresholdEditorBean extends ViewBeanParserBean, Persistable, ReportFrameElement
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.- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
applyChanges()
Applies all changes made to the threshold editor bean to the underlying thresholds object.void
clearThresholdCopies()
boolean
getAllowToggleThresholds()
This method can be used to toggle whether the user is allowed to toggle the thresholds in the report.java.util.Enumeration
getAttributesList()
Returns a list of attributes that are considered to be available to the user for editing the threshold.boolean
getAutoApply()
Returns whether to apply each change in the editor as it happens.WebThresholdsContainer
getContainer()
Retrieves the active container that was set usingWebThresholdsContainer
getContainerFromKey(java.lang.String key)
java.lang.String
getCopyContainerKey()
Returns the current container key that the user has selected for the "copy" operation.java.lang.String
getCopyThresholdID()
Returns the current threshold ID that the user has selected for the "copy" operation.java.lang.String
getCurrentContainerKey()
Returns the id of the currently selected container.java.lang.String
getCurrentRangeBoundaries()
Returns the current range boundary of the threshold.java.lang.String
getCurrentThresholdID()
Returns the currently selected threshold ID.RWDataSet
getDataSet()
ExpressionDisplayBean
getDisplayExpressionBean()
Returns the childExpressionDisplayBean
, which can be used to display subexpressions that are not being edited.ThresholdExpressionBean
getExpressionEditorBean()
Returns the childThresholdExpressionBean
, which is used to display and edit a single subexpression chosen by the user.java.lang.String
getExpressionEditorThresholdID()
Returns the ID of the threshold that theThresholdExpressionBean
is currently set to work on.java.util.Enumeration
getMetricsList()
Returns a list of metrics that are considered to be available to the user for editing the threshold.java.util.Enumeration
getMetricsListWithDataSetInfo(java.util.List dataSetList)
Returns a list of metrics that are considered to be available to the user for editing the threshold.boolean
getShowLabels()
Returns whether to show all value labels in the editorWebTemplateAttributes
getTemplateAttributes()
WebTemplateMetrics
getTemplateMetrics()
WebThresholds
getThresholds()
Retrieves thresholds corresponding to the current active container.WebThresholds
getThresholdsByKey(java.lang.String key)
This method can be used to get theWebThresholds
object corresponding to a specific container key.int
getThresholdsType()
Returns the type of the thresholds defined on the currently active container The type corresponds to a value fromEnumThresholdTypes
.int
getThresholdsType(java.lang.String key)
This method will return the thresholds type, fromEnumThresholdTypes
, of the thresholds collection associated with the given container key.WebWorkingSet
getWorkingSet()
boolean
isConditionalFormatting()
Returns true if we are editing threshold definition on the document field.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.void
setAllowToggleThresholds(boolean value)
This method can be used to toggle whether the user is allowed to toggle the thresholds in the report.void
setAutoApply(boolean value)
Sets whether to apply each change in the editor as it happens.void
setCurrentContainerKey(java.lang.String id)
Sets the id of the currently selected thresholds container in the editorvoid
setCurrentRangeBoundaries(java.lang.String value)
Sets the current range boundary of the threshold.void
setCurrentThresholdID(java.lang.String thresholdID)
Sets the currently selected threshold ID.void
setExpressionEditorThresholdID(java.lang.String thresholdID)
Sets the ID of the threshold that theThresholdExpressionBean
is currently set to work on.void
setShowLabels(boolean value)
Sets whether to show all value labels in the editor.-
Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop
-
Methods inherited from interface com.microstrategy.web.app.beans.FrameElement
getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement
getReportFrameBean, isGridDataNecessary
-
Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest
-
Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform
-
Methods inherited from interface com.microstrategy.web.app.beans.ViewBeanParserBean
getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey
-
Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setWebEventHandler
-
-
-
-
Method Detail
-
getContainer
WebThresholdsContainer getContainer()
Retrieves the active container that was set using
-
getCurrentThresholdID
java.lang.String getCurrentThresholdID()
Returns the currently selected threshold ID.
-
setCurrentThresholdID
void setCurrentThresholdID(java.lang.String thresholdID)
Sets the currently selected threshold ID.
-
getThresholdsType
int getThresholdsType()
Returns the type of the thresholds defined on the currently active container The type corresponds to a value fromEnumThresholdTypes
. 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, thenEnumThresholdTypes.TYPE_COMPLEX
is returned- Returns:
- The thresholds type of the currently selected threshold container.
-
getThresholds
WebThresholds getThresholds()
Retrieves thresholds corresponding to the current active container.- Returns:
- A
SimpleList
collection ofWebAppSimpleThreshold
objects
-
getMetricsList
java.util.Enumeration getMetricsList()
Returns a list of metrics that are considered to be available to the user for editing the threshold.
-
getAttributesList
java.util.Enumeration getAttributesList()
Returns a list of attributes that are considered to be available to the user for editing the threshold.
-
getMetricsListWithDataSetInfo
java.util.Enumeration getMetricsListWithDataSetInfo(java.util.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- Parameters:
dataSetList
-
-
getWorkingSet
WebWorkingSet getWorkingSet()
-
setCurrentContainerKey
void setCurrentContainerKey(java.lang.String id)
Sets the id of the currently selected thresholds container in the editor- Parameters:
id
- The current container ID.
-
getCurrentContainerKey
java.lang.String getCurrentContainerKey()
Returns the id of the currently selected container.- Returns:
- The current container ID.
-
setAutoApply
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.
-
getAutoApply
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.
-
setShowLabels
void setShowLabels(boolean value)
Sets whether to show all value labels in the editor.- Parameters:
value
- The new value of the setting.
-
getShowLabels
boolean getShowLabels()
Returns whether to show all value labels in the editor- Returns:
- boolean The current setting of the show all labels parameter.
-
setCurrentRangeBoundaries
void setCurrentRangeBoundaries(java.lang.String value)
Sets the current range boundary of the threshold.- Parameters:
value
- The new value for the range boundary.
-
getCurrentRangeBoundaries
java.lang.String getCurrentRangeBoundaries()
Returns the current range boundary of the threshold.- Returns:
- The current setting for the range boundary.
-
applyChanges
void applyChanges()
Applies all changes made to the threshold editor bean to the underlying thresholds object.
-
resetChanges
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.
-
getCopyContainerKey
java.lang.String getCopyContainerKey()
Returns the current container key that the user has selected for the "copy" operation.- Returns:
- The current copy container key.
-
getCopyThresholdID
java.lang.String getCopyThresholdID()
Returns the current threshold ID that the user has selected for the "copy" operation.- Returns:
- The copy threshold ID.
-
setExpressionEditorThresholdID
void setExpressionEditorThresholdID(java.lang.String thresholdID)
Sets the ID of the threshold that theThresholdExpressionBean
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.
-
getExpressionEditorThresholdID
java.lang.String getExpressionEditorThresholdID()
Returns the ID of the threshold that theThresholdExpressionBean
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.
-
getDisplayExpressionBean
ExpressionDisplayBean getDisplayExpressionBean()
Returns the childExpressionDisplayBean
, which can be used to display subexpressions that are not being edited.- Returns:
- The
ExpressionDisplayBean
that is a child of this bean.
-
getExpressionEditorBean
ThresholdExpressionBean getExpressionEditorBean()
Returns the childThresholdExpressionBean
, which is used to display and edit a single subexpression chosen by the user.- Returns:
- The
ThresholdExpressionBean
that is a child of this bean.
-
setAllowToggleThresholds
void setAllowToggleThresholds(boolean value) throws WebBeanException
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.
-
getAllowToggleThresholds
boolean getAllowToggleThresholds() throws WebBeanException
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.
-
getThresholdsByKey
WebThresholds getThresholdsByKey(java.lang.String key)
This method can be used to get theWebThresholds
object corresponding to a specific container key.- Parameters:
key
- The container key of the thresholds object to obtain.
-
getThresholdsType
int getThresholdsType(java.lang.String key)
This method will return the thresholds type, fromEnumThresholdTypes
, 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
.
-
isConditionalFormatting
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.
-
getDataSet
RWDataSet getDataSet()
-
getContainerFromKey
WebThresholdsContainer getContainerFromKey(java.lang.String key)
-
getTemplateMetrics
WebTemplateMetrics getTemplateMetrics() throws WebObjectsException, WebBeanException
- Throws:
WebObjectsException
WebBeanException
-
getTemplateAttributes
WebTemplateAttributes getTemplateAttributes() throws WebObjectsException, WebBeanException
- Throws:
WebObjectsException
WebBeanException
-
clearThresholdCopies
void clearThresholdCopies()
-
-