Package com.microstrategy.web.app.beans
Interface FormulaBarBean
-
- All Superinterfaces:
AppComponent
,DataSetParserBean
,EnumWebPersistableState
,FrameElement
,Persistable
,ReportFrameElement
,RequestPersistable
,TemplateElementsBean
,Transformable
,ViewBeanParserBean
,WebComponent
public interface FormulaBarBean extends TemplateElementsBean, ReportFrameElement
The FormulaBarBean is representing the formular bar for a report page. It's a subcomponent of ReportFrameBean. It can change alias for attributes or metrics, change formula for metrics, add derived metrics.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
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
-
Fields inherited from interface com.microstrategy.web.app.beans.TemplateElementsBean
ALL_DATASET_MODE, DATASET_MODE, GRID_MODE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
allowInsertNewMetric()
Check to see if the user is allowed to insert new metric.java.lang.String
getActiveAlias()
return the active name.TemplateElement
getActiveElement()
Returns the active template element.int
getActiveElementIndex()
java.lang.String
getActiveFormula()
return the active formula.java.lang.String
getActiveUserMetricId()
Returns the active User Metric Id.java.lang.Boolean
getAggFromBase()
return Aggregate from Base flag.int
getDMMode()
boolean
getDynamicAliasFlag()
return the dynamic alias flag.java.lang.String
getErrorMessage()
Indicates an error description when processing FormularBar events.java.util.ArrayList
getMetricsList()
Deprecated.The metrics list can be obtained from the working set.java.lang.String[][]
getTemplateElementsArray()
Deprecated.the element array can be obtained using theTemplateElementsBean.getTemplateElementsList()
method.boolean
isPassThrough()
void
setActiveAlias(java.lang.String activeAlias)
Set the active name.void
setActiveElementIndex(int activeElementIndex)
Set the Active element index.void
setActiveFormula(java.lang.String activeFormula)
Set the active formula.void
setActiveUserMetricId(java.lang.String activeUserMetricId)
Set the active User Metric Id.void
setAggFromBase(java.lang.Boolean aggFromBase)
Set Aggregate from Base flag.void
setDynamicAliasFlag(boolean dynamicAliasFlag)
Set the dynamic alias flag.void
setErrorMessage(java.lang.String errMssg)
Specify an error description when processing FormularBar events.void
setPassThrough(boolean value)
-
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.DataSetParserBean
getActiveDatasetId, getUserMetricsFromDataset, setActiveDatasetId
-
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.app.beans.TemplateElementsBean
getDatasets, getMode, getTemplateElementsList, getWebTemplate, getWebWorkingSet, setMode
-
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
getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, 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
-
getActiveElementIndex
int getActiveElementIndex()
- Specified by:
getActiveElementIndex
in interfaceViewBeanParserBean
- Returns:
- the Active element index. It's used to pre-select an item in the template elements list
-
setActiveElementIndex
void setActiveElementIndex(int activeElementIndex)
Set the Active element index. It's used to pre-select an item in the template elements list- Specified by:
setActiveElementIndex
in interfaceViewBeanParserBean
- Parameters:
activeElementIndex
- the active element index
-
getActiveAlias
java.lang.String getActiveAlias()
return the active name. It's used to pre-fill the textbox for the Alias textbox.- Returns:
- the active name.
-
setActiveAlias
void setActiveAlias(java.lang.String activeAlias)
Set the active name. It's used to pre-fill the textbox for the Alias textbox.- Parameters:
activeAlias
- the alias in String format
-
getDynamicAliasFlag
boolean getDynamicAliasFlag()
return the dynamic alias flag. It's used to pre-fill the dynamic alias checkbox.- Returns:
- the active name.
-
setDynamicAliasFlag
void setDynamicAliasFlag(boolean dynamicAliasFlag)
Set the dynamic alias flag. It's used to pre-fill the dynamic alias checkbox.- Parameters:
dynamicAliasFlag
- the alias flag in boolean format
-
getActiveFormula
java.lang.String getActiveFormula()
return the active formula. It's used to pre-fill the textbox for the formula textbox.- Returns:
- the active formula.
-
setActiveFormula
void setActiveFormula(java.lang.String activeFormula)
Set the active formula. It's used to pre-fill the textbox for the Formula textbox.- Parameters:
activeFormula
- the formula in String format
-
setAggFromBase
void setAggFromBase(java.lang.Boolean aggFromBase)
Set Aggregate from Base flag.- Parameters:
aggFromBase
- the Aggregate from Base flag
-
getAggFromBase
java.lang.Boolean getAggFromBase()
return Aggregate from Base flag.- Returns:
- the Aggregate from Base flag.
-
getActiveElement
TemplateElement getActiveElement()
Returns the active template element.- Returns:
- TemplateElement instance.
- Since:
- MicroStrategy Web 8.0.0
-
setErrorMessage
void setErrorMessage(java.lang.String errMssg)
Specify an error description when processing FormularBar events.- Parameters:
errMssg
- Localized error message.- Since:
- MicroStrategy Web 8.0.0
-
getErrorMessage
java.lang.String getErrorMessage()
Indicates an error description when processing FormularBar events.- Returns:
- errMssg Localized error message.
- Since:
- MicroStrategy Web 8.0.0
-
setActiveUserMetricId
void setActiveUserMetricId(java.lang.String activeUserMetricId)
Set the active User Metric Id.
It's used for indicating which User Metric was selected.- Parameters:
activeUserMetricId
- The specific User Metric Id to set as active.- Since:
- MicroStrategy Web 8.0.0
-
getActiveUserMetricId
java.lang.String getActiveUserMetricId()
Returns the active User Metric Id.- Returns:
- String Id
- Since:
- MicroStrategy Web 8.0.0
-
allowInsertNewMetric
boolean allowInsertNewMetric()
Check to see if the user is allowed to insert new metric.- Returns:
- boolean true if insertion is allowed
- Since:
- MicroStrategy Web 9.0.0
-
getTemplateElementsArray
java.lang.String[][] getTemplateElementsArray()
Deprecated.the element array can be obtained using theTemplateElementsBean.getTemplateElementsList()
method.Returns list of elements in template.- Returns:
- String
- Since:
- MicroStrategy Web 8.0.0
-
getMetricsList
java.util.ArrayList getMetricsList()
Deprecated.The metrics list can be obtained from the working set.Returns the list of metrics in the working set- Returns:
- ArrayList
- Since:
- MicroStrategy Web 8.0.0
-
getDMMode
int getDMMode()
-
setPassThrough
void setPassThrough(boolean value)
-
isPassThrough
boolean isPassThrough()
-
-