public interface

FormulaBarBean

implements ReportFrameElement TemplateElementsBean
com.microstrategy.web.app.beans.FormulaBarBean

Class Overview

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.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.TemplateElementsBean
Public Methods
abstract boolean allowInsertNewMetric()
Check to see if the user is allowed to insert new metric.
abstract String getActiveAlias()
return the active name.
abstract TemplateElement getActiveElement()
Returns the active template element.
abstract int getActiveElementIndex()
abstract String getActiveFormula()
return the active formula.
abstract String getActiveUserMetricId()
Returns the active User Metric Id.
abstract Boolean getAggFromBase()
return Aggregate from Base flag.
abstract int getDMMode()
abstract boolean getDynamicAliasFlag()
return the dynamic alias flag.
abstract String getErrorMessage()
Indicates an error description when processing FormularBar events.
abstract ArrayList getMetricsList()
This method is deprecated. The metrics list can be obtained from the working set.
abstract String[][] getTemplateElementsArray()
This method is deprecated. the element array can be obtained using the getTemplateElementsList() method.
abstract boolean isPassThrough()
abstract void setActiveAlias(String activeAlias)
Set the active name.
abstract void setActiveElementIndex(int activeElementIndex)
Set the Active element index.
abstract void setActiveFormula(String activeFormula)
Set the active formula.
abstract void setActiveUserMetricId(String activeUserMetricId)
Set the active User Metric Id.
abstract void setAggFromBase(Boolean aggFromBase)
Set Aggregate from Base flag.
abstract void setDynamicAliasFlag(boolean dynamicAliasFlag)
Set the dynamic alias flag.
abstract void setErrorMessage(String errMssg)
Specify an error description when processing FormularBar events.
abstract void setPassThrough(boolean value)
[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.DataSetParserBean
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.app.beans.TemplateElementsBean
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 boolean allowInsertNewMetric ()

Check to see if the user is allowed to insert new metric.

Returns
  • boolean true if insertion is allowed

public abstract String getActiveAlias ()

return the active name. It's used to pre-fill the textbox for the Alias textbox.

Returns
  • the active name.

public abstract TemplateElement getActiveElement ()

Returns the active template element.

Returns
  • TemplateElement instance.

public abstract int getActiveElementIndex ()

Returns
  • the Active element index. It's used to pre-select an item in the template elements list

public abstract String getActiveFormula ()

return the active formula. It's used to pre-fill the textbox for the formula textbox.

Returns
  • the active formula.

public abstract String getActiveUserMetricId ()

Returns the active User Metric Id.

Returns
  • String Id

public abstract Boolean getAggFromBase ()

return Aggregate from Base flag.

Returns
  • the Aggregate from Base flag.

public abstract int getDMMode ()

public abstract boolean getDynamicAliasFlag ()

return the dynamic alias flag. It's used to pre-fill the dynamic alias checkbox.

Returns
  • the active name.

public abstract String getErrorMessage ()

Indicates an error description when processing FormularBar events.

Returns
  • errMssg Localized error message.

public abstract ArrayList getMetricsList ()

This method is deprecated.
The metrics list can be obtained from the working set.

Returns the list of metrics in the working set

Returns
  • ArrayList

public abstract String[][] getTemplateElementsArray ()

This method is deprecated.
the element array can be obtained using the getTemplateElementsList() method.

Returns list of elements in template.

Returns
  • String

public abstract boolean isPassThrough ()

public abstract void setActiveAlias (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

public abstract void setActiveElementIndex (int activeElementIndex)

Set the Active element index. It's used to pre-select an item in the template elements list

Parameters
activeElementIndex the active element index

public abstract void setActiveFormula (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

public abstract void setActiveUserMetricId (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.

public abstract void setAggFromBase (Boolean aggFromBase)

Set Aggregate from Base flag.

Parameters
aggFromBase the Aggregate from Base flag

public abstract 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

public abstract void setErrorMessage (String errMssg)

Specify an error description when processing FormularBar events.

Parameters
errMssg Localized error message.

public abstract void setPassThrough (boolean value)