Package com.microstrategy.web.app.beans
Interface ReportFrameBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,FrameBean
,Persistable
,RequestPersistable
,Transformable
,WebComponent
- All Known Implementing Classes:
ReportFrameBeanImpl
public interface ReportFrameBean extends FrameBean
The interface ReportFrameBean is representing the report frame web component, whose children components are of ReportFrameElement type. Extends the FrameBean by adding all the report elements.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT_DESIGN_MODE_BUTTONS
static java.lang.String
COMPONENT_FORMAT_EDITOR
static java.lang.String
COMPONENT_GRAPH_TOOLBAR
static java.lang.String
COMPONENT_GRID_EDITOR
static java.lang.String
COMPONENT_GRID_TOOLBAR
static java.lang.String
COMPONENT_MESSAGE_BEFORE_DATA
static java.lang.String
COMPONENT_OBJECT_BROWSER
static java.lang.String
COMPONENT_PAGE_BY
static java.lang.String
COMPONENT_PROMPT_DETAILS
static java.lang.String
COMPONENT_REPORT_DATA
static java.lang.String
COMPONENT_REPORT_ERROR
static java.lang.String
COMPONENT_REPORT_FILTER
static java.lang.String
COMPONENT_REPORT_LAST_UPDATE
static java.lang.String
COMPONENT_REPORT_LIMIT
static java.lang.String
COMPONENT_REPORT_MENUS
static java.lang.String
COMPONENT_REPORT_PAGEBY
static java.lang.String
COMPONENT_REPORT_TOOLBAR
static java.lang.String
COMPONENT_VIEW_FILTER
static java.lang.String
COMPONENT_VIEW_LIMIT
static java.lang.String
COMPONENT_VISUALIZATION_PROPS_EDITOR
-
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 Deprecated Methods Modifier and Type Method Description AttributeFormsEditorBean
getAttributeFormsEditorBean()
Returns the attribute forms editor bean within this report frame bean.DerivedElementsEditorBean
getDerivedElementsEditor()
int
getDesignMode()
Returns the view mode of the report frame bean (a value from EnumReportViewModes)int
getDesignModeStage()
Returns the design mode stage of the report frame bean ReportDesignModeStage_EditTemplate or ReportDesignModeStage_EditFilter (EnumReportDesignMode))DrillEditorBean
getDrillEditorBean()
Returns the drill editor bean within this report frame bean.DrillFilterEditorBean
getDrillFilterEditorBean()
Returns the drill filter editor bean within this report frame bean.int
getExecutionMode()
Returns the view mode of the report frame bean (a value from EnumReportViewModes) including value for Create ReportFilterElementBean
getFilterElement(int type)
FormulaBarBean
getFormulaBarBean()
Returns the formular bar bean within this report frame bean.GraphFormatEditorBean
getGraphFormatEditorBean()
Returns the graph format editor bean within this report frame bean.GraphFormatToolbarBean
getGraphFormatToolbarBean()
Returns the graph format toolbar bean within this report frame bean.GridFormatEditorBean
getGridFormatEditorBean()
Returns the grid format editor bean within this report frame bean.GridFormatToolbarBean
getGridFormatToolbarBean()
Returns the grid format toolbar bean within this report frame bean.boolean
getIsDesignMode()
Returns whether the view mode of the report frame bean (a value from EnumReportViewModes) is equal toEnumReportViewModes.ReportViewModeDesign
ObjectBrowserBean
getObjectBrowserBean()
Deprecated.This method is no longer used.ObjectBrowserManagerBean
getObjectBrowserTabMgrBean()
Returns the ObjectBrowser bean associated with the report frame bean.PageByBean
getPageByBean()
Returns the PageBy editor bean.PromptDetailsBean
getPromptDetailsBean()
Returns aPromptDetailsBean
object corresponding to the prompt details.PromptsContainerBean
getPromptsContainerBean()
Returns aPromptsContainerBean
object corresponding to the prompts container.boolean
getRefreshGrid()
Retrieves the flag indicating whether to refresh the grid or not.ReportBean
getReportBean()
Returns the report bean associated with this report frame bean.ReportDetailsBean
getReportDetailsBean()
Returns aReportDetailsBean
object corresponding to the report details.java.lang.String
getReportEditorName()
Retrieves the name of the current open report editorFilterEditorBean
getReportFilterEditor()
Returns the report filter editor bean within this report frame bean.FilterElementBean
getReportFilterElement()
Returns aFilterElementBean
object corresponding to the report filter.FilterElementBean
getReportLimitElement()
java.lang.String
getReportStyleLocalizedName()
Deprecated.The FrameBean is not responsible to render it's output.ResizeEditorBean
getResizeEditorBean()
Returns the resize editor bean within this report frame bean.SubscriptionEditorBean
getSchedulesEditorBean()
Deprecated.No longer used by the ApplicationSubscriptionEditorBean
getSendNowEditorBean()
Deprecated.No longer used by the ApplicationSortEditorBean
getSortEditorBean()
Returns the sort editor bean within this report frame bean.SubscriptionEditorBean
getSubscriptionsEditorBean()
Deprecated.No longer used by the ApplicationFilterEditorBean
getViewFilterEditor()
Returns the view filter editor bean within this report frame bean.FilterElementBean
getViewFilterElement()
Returns aFilterElementBean
object corresponding to the view filter.FilterElementBean
getViewLimitElement()
boolean
isNoActionFlagRemoved()
boolean
isReportToolbarEnabled()
Returns true if the report toolbar should be enabledvoid
setDesignMode(int designMode)
Sets the view mode of the report frame bean (a value from EnumReportViewModes)void
setDesignModeStage(int designModeStage)
Sets the design mode stage of the report frame beanvoid
setExecutionMode(int executeMode)
Sets the view mode of the report frame bean (a value from EnumReportViewModes)void
setNoActionFlagRemoved(boolean isRemoved)
Set this to true if we just removed the noAction flag from the executionFlags when switch a report from design mode to view modevoid
setRefreshGrid(boolean value)
Sets a flag indicating whether to refresh the grid or not.void
setReportEditorName(java.lang.String value)
Sets the name of the report editor to be openvoid
setXMLStatus(int value)
Sets the EnumRequestStatus status of the bean.-
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.FrameBean
closeElement, getCurrentEditor, getDynamicMenuName, getEditorMessage, getIFrameComponent, getMenus, getMessageBeforeData, getPromptStyle, getTargetBean, getUseIFrame, isOpen, openElement, setDynamicMenuName, setEditorMessage, setMessageBeforeData, setPromptStyle, setUseIFrame, shouldDisplayContent
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
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.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, getTargetBeanPath, 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, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Field Detail
-
COMPONENT_REPORT_MENUS
static final java.lang.String COMPONENT_REPORT_MENUS
- See Also:
- Constant Field Values
-
COMPONENT_REPORT_DATA
static final java.lang.String COMPONENT_REPORT_DATA
- See Also:
- Constant Field Values
-
COMPONENT_REPORT_LAST_UPDATE
static final java.lang.String COMPONENT_REPORT_LAST_UPDATE
- See Also:
- Constant Field Values
-
COMPONENT_REPORT_TOOLBAR
static final java.lang.String COMPONENT_REPORT_TOOLBAR
- See Also:
- Constant Field Values
-
COMPONENT_REPORT_ERROR
static final java.lang.String COMPONENT_REPORT_ERROR
- See Also:
- Constant Field Values
-
COMPONENT_REPORT_FILTER
static final java.lang.String COMPONENT_REPORT_FILTER
- See Also:
- Constant Field Values
-
COMPONENT_REPORT_PAGEBY
static final java.lang.String COMPONENT_REPORT_PAGEBY
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
COMPONENT_REPORT_LIMIT
static final java.lang.String COMPONENT_REPORT_LIMIT
- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
COMPONENT_VIEW_FILTER
static final java.lang.String COMPONENT_VIEW_FILTER
- See Also:
- Constant Field Values
-
COMPONENT_VIEW_LIMIT
static final java.lang.String COMPONENT_VIEW_LIMIT
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
COMPONENT_GRID_TOOLBAR
static final java.lang.String COMPONENT_GRID_TOOLBAR
- See Also:
- Constant Field Values
-
COMPONENT_GRAPH_TOOLBAR
static final java.lang.String COMPONENT_GRAPH_TOOLBAR
- See Also:
- Constant Field Values
-
COMPONENT_PAGE_BY
static final java.lang.String COMPONENT_PAGE_BY
- See Also:
- Constant Field Values
-
COMPONENT_OBJECT_BROWSER
static final java.lang.String COMPONENT_OBJECT_BROWSER
- See Also:
- Constant Field Values
-
COMPONENT_FORMAT_EDITOR
static final java.lang.String COMPONENT_FORMAT_EDITOR
- See Also:
- Constant Field Values
-
COMPONENT_GRID_EDITOR
static final java.lang.String COMPONENT_GRID_EDITOR
- See Also:
- Constant Field Values
-
COMPONENT_DESIGN_MODE_BUTTONS
static final java.lang.String COMPONENT_DESIGN_MODE_BUTTONS
- See Also:
- Constant Field Values
-
COMPONENT_MESSAGE_BEFORE_DATA
static final java.lang.String COMPONENT_MESSAGE_BEFORE_DATA
- See Also:
- Constant Field Values
-
COMPONENT_VISUALIZATION_PROPS_EDITOR
static final java.lang.String COMPONENT_VISUALIZATION_PROPS_EDITOR
- See Also:
- Constant Field Values
-
COMPONENT_PROMPT_DETAILS
static final java.lang.String COMPONENT_PROMPT_DETAILS
- Since:
- MicroStrategy Web 8.0.1
- See Also:
- Constant Field Values
-
-
Method Detail
-
getReportBean
ReportBean getReportBean()
Returns the report bean associated with this report frame bean.- Returns:
- the report bean associated with this report frame bean
-
getObjectBrowserBean
ObjectBrowserBean getObjectBrowserBean()
Deprecated.This method is no longer used. getObjectBrowserTabMgrBean() should be used insteadReturns the ObjectBrowser bean associated with this report frame bean.- Returns:
- the ObjectBrowser bean associated with this report frame bean
-
getObjectBrowserTabMgrBean
ObjectBrowserManagerBean getObjectBrowserTabMgrBean()
Returns the ObjectBrowser bean associated with the report frame bean. The ObjectBrowser is now a TabManagerBean.- Returns:
- TabManagerBean
- Since:
- MicroStrategy Web 8.0.0
-
getFormulaBarBean
FormulaBarBean getFormulaBarBean()
Returns the formular bar bean within this report frame bean.- Returns:
- the formular bar bean within this report frame bean.
-
getAttributeFormsEditorBean
AttributeFormsEditorBean getAttributeFormsEditorBean()
Returns the attribute forms editor bean within this report frame bean.- Returns:
- the attribute forms editor bean within this report frame bean.
- Since:
- MicroStrategy Web 8.0.0
-
getGraphFormatToolbarBean
GraphFormatToolbarBean getGraphFormatToolbarBean()
Returns the graph format toolbar bean within this report frame bean.- Returns:
- the graph format toolbar within this report frame bean
-
getGridFormatToolbarBean
GridFormatToolbarBean getGridFormatToolbarBean()
Returns the grid format toolbar bean within this report frame bean.- Returns:
- the grid format toolbar within this report frame bean.
-
getReportFilterEditor
FilterEditorBean getReportFilterEditor()
Returns the report filter editor bean within this report frame bean.- Returns:
- the report filter editor bean within this report frame bean.
-
getViewFilterEditor
FilterEditorBean getViewFilterEditor()
Returns the view filter editor bean within this report frame bean.- Returns:
- the view filter editor bean within this report frame bean.
-
getGridFormatEditorBean
GridFormatEditorBean getGridFormatEditorBean()
Returns the grid format editor bean within this report frame bean.- Returns:
- the grid format editor within this report frame bean.
-
getGraphFormatEditorBean
GraphFormatEditorBean getGraphFormatEditorBean()
Returns the graph format editor bean within this report frame bean.- Returns:
- the graph format editor within this report frame bean.
-
getDrillEditorBean
DrillEditorBean getDrillEditorBean()
Returns the drill editor bean within this report frame bean.- Returns:
- the drill editor bean within this report frame bean.
-
getDrillFilterEditorBean
DrillFilterEditorBean getDrillFilterEditorBean()
Returns the drill filter editor bean within this report frame bean.- Returns:
- the drill filter editor bean within this report frame bean.
-
getSortEditorBean
SortEditorBean getSortEditorBean()
Returns the sort editor bean within this report frame bean.- Returns:
- the sort editor bean within this report frame bean.
-
getResizeEditorBean
ResizeEditorBean getResizeEditorBean()
Returns the resize editor bean within this report frame bean.- Returns:
- the resize editor bean within this report frame bean.
-
getSchedulesEditorBean
SubscriptionEditorBean getSchedulesEditorBean()
Deprecated.No longer used by the ApplicationReturns the Subscription editor bean to use with web Subscriptions.- Returns:
- the Subscription editor bean to use with web Subscriptions.
-
getSubscriptionsEditorBean
SubscriptionEditorBean getSubscriptionsEditorBean()
Deprecated.No longer used by the ApplicationReturns the Subscription editor bean to use with Narrowcast Subscriptions.- Returns:
- the Subscription editor bean to use with Narrowcast Subscriptions.
-
getSendNowEditorBean
SubscriptionEditorBean getSendNowEditorBean()
Deprecated.No longer used by the ApplicationReturns the Subscription editor bean to use with Send Now feature.- Returns:
- the Subscription editor bean to use with Send Now feature.
-
getPageByBean
PageByBean getPageByBean()
Returns the PageBy editor bean.- Returns:
- the PageBy editor bean.
- Since:
- MicroStrategy Web 8.0.0
-
getDesignMode
int getDesignMode()
Returns the view mode of the report frame bean (a value from EnumReportViewModes)- Returns:
- the view mode of the report frame bean (a value from EnumReportViewModes)
-
getIsDesignMode
boolean getIsDesignMode()
Returns whether the view mode of the report frame bean (a value from EnumReportViewModes) is equal toEnumReportViewModes.ReportViewModeDesign
- Returns:
- boolean true if the the report frame bean is in design mode
- Since:
- MicroStrategy Web 9.0.0
-
getExecutionMode
int getExecutionMode()
Returns the view mode of the report frame bean (a value from EnumReportViewModes) including value for Create Report- Returns:
- the view mode of the report frame bean (a value from EnumReportViewModes)
-
setDesignMode
void setDesignMode(int designMode)
Sets the view mode of the report frame bean (a value from EnumReportViewModes)- Parameters:
designMode
- the view mode of the report frame bean (a value from EnumReportViewModes)
-
setExecutionMode
void setExecutionMode(int executeMode)
Sets the view mode of the report frame bean (a value from EnumReportViewModes)- Parameters:
executeMode
- the view mode of the report frame bean (a value from EnumReportViewModes)
-
getDesignModeStage
int getDesignModeStage()
Returns the design mode stage of the report frame bean ReportDesignModeStage_EditTemplate or ReportDesignModeStage_EditFilter (EnumReportDesignMode))- Returns:
- the design mode stage of the report frame bean
-
setDesignModeStage
void setDesignModeStage(int designModeStage)
Sets the design mode stage of the report frame bean- Parameters:
designModeStage
- the design mode stage of the report frame bean (a value from EnumReportDesignMode)
-
isReportToolbarEnabled
boolean isReportToolbarEnabled()
Returns true if the report toolbar should be enabled- Returns:
- isReportToolbarEnabled
-
getReportStyleLocalizedName
java.lang.String getReportStyleLocalizedName()
Deprecated.The FrameBean is not responsible to render it's output.- Returns:
- the report bean's localized style name. It's used for old-formatting reports to apply style first before other formattig manipulation.
-
setXMLStatus
void setXMLStatus(int value)
Sets the EnumRequestStatus status of the bean.- Parameters:
value
- The XML status value ofor this bean.
-
setReportEditorName
void setReportEditorName(java.lang.String value)
Sets the name of the report editor to be open- Parameters:
value
- The name of the report editor to be open- Since:
- MicroStrategy Web 8.0.0
-
getReportEditorName
java.lang.String getReportEditorName()
Retrieves the name of the current open report editor- Returns:
- The name of the current open report editor
- Since:
- MicroStrategy Web 8.0.0
-
getReportFilterElement
FilterElementBean getReportFilterElement()
Returns aFilterElementBean
object corresponding to the report filter.- Returns:
- A
FilterElementBean
corresponding to the report filter. - Since:
- MicroStrategy Web 8.0.0
-
getReportLimitElement
FilterElementBean getReportLimitElement()
- Since:
- MicroStrategy Web 8.0.2
-
getViewFilterElement
FilterElementBean getViewFilterElement()
Returns aFilterElementBean
object corresponding to the view filter.- Returns:
- A
FilterElementBean
corresponding to the view filter. - Since:
- MicroStrategy Web 8.0.0
-
getPromptDetailsBean
PromptDetailsBean getPromptDetailsBean()
Returns aPromptDetailsBean
object corresponding to the prompt details.- Returns:
- A
PromptDetailsBean
corresponding to the prompt details. - Since:
- MicroStrategy Web 8.0.1
-
getPromptsContainerBean
PromptsContainerBean getPromptsContainerBean()
Returns aPromptsContainerBean
object corresponding to the prompts container.- Returns:
- A
PromptsContainerBean
corresponding to the prompts Container. - Since:
- MicroStrategy Web 9.0.0
-
getFilterElement
FilterElementBean getFilterElement(int type)
- Since:
- MicroStrategy Web 8.0.2
-
setRefreshGrid
void setRefreshGrid(boolean value)
Sets a flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.- Since:
- MicroStrategy Web 8.1.1
-
getRefreshGrid
boolean getRefreshGrid()
Retrieves the flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.- Since:
- MicroStrategy Web 8.1.1
-
getViewLimitElement
FilterElementBean getViewLimitElement()
- Since:
- MicroStrategy Web 9.0.0
-
getDerivedElementsEditor
DerivedElementsEditorBean getDerivedElementsEditor()
- Since:
- MicroStrategy Web 9.0.0
-
getReportDetailsBean
ReportDetailsBean getReportDetailsBean()
Returns aReportDetailsBean
object corresponding to the report details.- Returns:
- A
ReportDetailsBean
corresponding to the report details. - Since:
- MicroStrategy Web 9.0.0
-
setNoActionFlagRemoved
void setNoActionFlagRemoved(boolean isRemoved)
Set this to true if we just removed the noAction flag from the executionFlags when switch a report from design mode to view mode- Parameters:
isRemoved
- boolean true indicates we just remove the noAction flag from the executionFlags when switch a report from design mode to view mode
-
isNoActionFlagRemoved
boolean isNoActionFlagRemoved()
- Returns:
- whether we have just removed the noAction flag from the executionFlags when switch a report from design mode to view mode
-
-