public interface

ReportFrameBean

implements FrameBean
com.microstrategy.web.app.beans.ReportFrameBean
Known Indirect Subclasses

Class Overview

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.

Summary

Constants
String COMPONENT_DESIGN_MODE_BUTTONS
String COMPONENT_FORMAT_EDITOR
String COMPONENT_GRAPH_TOOLBAR
String COMPONENT_GRID_EDITOR
String COMPONENT_GRID_TOOLBAR
String COMPONENT_MESSAGE_BEFORE_DATA
String COMPONENT_OBJECT_BROWSER
String COMPONENT_PAGE_BY
String COMPONENT_PROMPT_DETAILS
String COMPONENT_REPORT_DATA
String COMPONENT_REPORT_ERROR
String COMPONENT_REPORT_FILTER
String COMPONENT_REPORT_LAST_UPDATE
String COMPONENT_REPORT_LIMIT
String COMPONENT_REPORT_MENUS
String COMPONENT_REPORT_PAGEBY
String COMPONENT_REPORT_TOOLBAR
String COMPONENT_VIEW_FILTER
String COMPONENT_VIEW_LIMIT
String COMPONENT_VISUALIZATION_PROPS_EDITOR
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract AttributeFormsEditorBean getAttributeFormsEditorBean()
Returns the attribute forms editor bean within this report frame bean.
abstract DerivedElementsEditorBean getDerivedElementsEditor()
abstract int getDesignMode()
Returns the view mode of the report frame bean (a value from EnumReportViewModes)
abstract int getDesignModeStage()
Returns the design mode stage of the report frame bean ReportDesignModeStage_EditTemplate or ReportDesignModeStage_EditFilter (EnumReportDesignMode))
abstract DrillEditorBean getDrillEditorBean()
Returns the drill editor bean within this report frame bean.
abstract DrillFilterEditorBean getDrillFilterEditorBean()
Returns the drill filter editor bean within this report frame bean.
abstract int getExecutionMode()
Returns the view mode of the report frame bean (a value from EnumReportViewModes) including value for Create Report
abstract FilterElementBean getFilterElement(int type)
abstract FormulaBarBean getFormulaBarBean()
Returns the formular bar bean within this report frame bean.
abstract GraphFormatEditorBean getGraphFormatEditorBean()
Returns the graph format editor bean within this report frame bean.
abstract GraphFormatToolbarBean getGraphFormatToolbarBean()
Returns the graph format toolbar bean within this report frame bean.
abstract GridFormatEditorBean getGridFormatEditorBean()
Returns the grid format editor bean within this report frame bean.
abstract GridFormatToolbarBean getGridFormatToolbarBean()
Returns the grid format toolbar bean within this report frame bean.
abstract boolean getIsDesignMode()
Returns whether the view mode of the report frame bean (a value from EnumReportViewModes) is equal to ReportViewModeDesign
abstract ObjectBrowserBean getObjectBrowserBean()
This method is deprecated. This method is no longer used. getObjectBrowserTabMgrBean() should be used instead
abstract ObjectBrowserManagerBean getObjectBrowserTabMgrBean()
Returns the ObjectBrowser bean associated with the report frame bean.
abstract PageByBean getPageByBean()
Returns the PageBy editor bean.
abstract PromptDetailsBean getPromptDetailsBean()
Returns a PromptDetailsBean object corresponding to the prompt details.
abstract PromptsContainerBean getPromptsContainerBean()
Returns a PromptsContainerBean object corresponding to the prompts container.
abstract boolean getRefreshGrid()
Retrieves the flag indicating whether to refresh the grid or not.
abstract ReportBean getReportBean()
Returns the report bean associated with this report frame bean.
abstract ReportDetailsBean getReportDetailsBean()
Returns a ReportDetailsBean object corresponding to the report details.
abstract String getReportEditorName()
Retrieves the name of the current open report editor
abstract FilterEditorBean getReportFilterEditor()
Returns the report filter editor bean within this report frame bean.
abstract FilterElementBean getReportFilterElement()
Returns a FilterElementBean object corresponding to the report filter.
abstract FilterElementBean getReportLimitElement()
abstract String getReportStyleLocalizedName()
This method is deprecated. The FrameBean is not responsible to render it's output.
abstract ResizeEditorBean getResizeEditorBean()
Returns the resize editor bean within this report frame bean.
abstract SubscriptionEditorBean getSchedulesEditorBean()
This method is deprecated. No longer used by the Application
abstract SubscriptionEditorBean getSendNowEditorBean()
This method is deprecated. No longer used by the Application
abstract SortEditorBean getSortEditorBean()
Returns the sort editor bean within this report frame bean.
abstract SubscriptionEditorBean getSubscriptionsEditorBean()
This method is deprecated. No longer used by the Application
abstract FilterEditorBean getViewFilterEditor()
Returns the view filter editor bean within this report frame bean.
abstract FilterElementBean getViewFilterElement()
Returns a FilterElementBean object corresponding to the view filter.
abstract FilterElementBean getViewLimitElement()
abstract boolean isNoActionFlagRemoved()
abstract boolean isReportToolbarEnabled()
Returns true if the report toolbar should be enabled
abstract void setDesignMode(int designMode)
Sets the view mode of the report frame bean (a value from EnumReportViewModes)
abstract void setDesignModeStage(int designModeStage)
Sets the design mode stage of the report frame bean
abstract void setExecutionMode(int executeMode)
Sets the view mode of the report frame bean (a value from EnumReportViewModes)
abstract 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
abstract void setRefreshGrid(boolean value)
Sets a flag indicating whether to refresh the grid or not.
abstract void setReportEditorName(String value)
Sets the name of the report editor to be open
abstract void setXMLStatus(int value)
Sets the EnumRequestStatus status of the bean.
[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.FrameBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final String COMPONENT_DESIGN_MODE_BUTTONS

Constant Value: "report_design_mode_buttons"

public static final String COMPONENT_FORMAT_EDITOR

Constant Value: "report_format_editor"

public static final String COMPONENT_GRAPH_TOOLBAR

Constant Value: "report_toolbar_graph"

public static final String COMPONENT_GRID_EDITOR

Constant Value: "report_editor_grid"

public static final String COMPONENT_GRID_TOOLBAR

Constant Value: "report_toolbar_grid"

public static final String COMPONENT_MESSAGE_BEFORE_DATA

Constant Value: "frame_message_before_data"

public static final String COMPONENT_OBJECT_BROWSER

Constant Value: "report_editor_ob"

public static final String COMPONENT_PAGE_BY

Constant Value: "report_page_by"

public static final String COMPONENT_PROMPT_DETAILS

Constant Value: "report_prompt_details"

public static final String COMPONENT_REPORT_DATA

Constant Value: "report_data"

public static final String COMPONENT_REPORT_ERROR

Constant Value: "report_error"

public static final String COMPONENT_REPORT_FILTER

Constant Value: "report_report_filter"

public static final String COMPONENT_REPORT_LAST_UPDATE

Constant Value: "report_last_update"

public static final String COMPONENT_REPORT_LIMIT

Constant Value: "report_report_limit"

public static final String COMPONENT_REPORT_MENUS

Constant Value: "report_menus"

public static final String COMPONENT_REPORT_PAGEBY

Constant Value: "report_page_by"

public static final String COMPONENT_REPORT_TOOLBAR

Constant Value: "report_toolbar"

public static final String COMPONENT_VIEW_FILTER

Constant Value: "report_view_filter"

public static final String COMPONENT_VIEW_LIMIT

Constant Value: "report_view_limit"

public static final String COMPONENT_VISUALIZATION_PROPS_EDITOR

Constant Value: "visPropsEditor"

Public Methods

public abstract AttributeFormsEditorBean getAttributeFormsEditorBean ()

Returns the attribute forms editor bean within this report frame bean.

Returns
  • the attribute forms editor bean within this report frame bean.

public abstract DerivedElementsEditorBean getDerivedElementsEditor ()

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

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

public abstract DrillEditorBean getDrillEditorBean ()

Returns the drill editor bean within this report frame bean.

Returns
  • the drill editor bean within this report frame bean.

public abstract DrillFilterEditorBean getDrillFilterEditorBean ()

Returns the drill filter editor bean within this report frame bean.

Returns
  • the drill filter editor bean within this report frame bean.

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

public abstract FilterElementBean getFilterElement (int type)

public abstract FormulaBarBean getFormulaBarBean ()

Returns the formular bar bean within this report frame bean.

Returns
  • the formular bar bean within this report frame bean.

public abstract GraphFormatEditorBean getGraphFormatEditorBean ()

Returns the graph format editor bean within this report frame bean.

Returns
  • the graph format editor within this report frame bean.

public abstract GraphFormatToolbarBean getGraphFormatToolbarBean ()

Returns the graph format toolbar bean within this report frame bean.

Returns
  • the graph format toolbar within this report frame bean

public abstract GridFormatEditorBean getGridFormatEditorBean ()

Returns the grid format editor bean within this report frame bean.

Returns
  • the grid format editor within this report frame bean.

public abstract GridFormatToolbarBean getGridFormatToolbarBean ()

Returns the grid format toolbar bean within this report frame bean.

Returns
  • the grid format toolbar within this report frame bean.

public abstract boolean getIsDesignMode ()

Returns whether the view mode of the report frame bean (a value from EnumReportViewModes) is equal to ReportViewModeDesign

Returns
  • boolean true if the the report frame bean is in design mode

public abstract ObjectBrowserBean getObjectBrowserBean ()

This method is deprecated.
This method is no longer used. getObjectBrowserTabMgrBean() should be used instead

Returns the ObjectBrowser bean associated with this report frame bean.

Returns
  • the ObjectBrowser bean associated with this report frame bean

public abstract ObjectBrowserManagerBean getObjectBrowserTabMgrBean ()

Returns the ObjectBrowser bean associated with the report frame bean. The ObjectBrowser is now a TabManagerBean.

Returns
  • TabManagerBean

public abstract PageByBean getPageByBean ()

Returns the PageBy editor bean.

Returns
  • the PageBy editor bean.

public abstract PromptDetailsBean getPromptDetailsBean ()

Returns a PromptDetailsBean object corresponding to the prompt details.

Returns

public abstract PromptsContainerBean getPromptsContainerBean ()

Returns a PromptsContainerBean object corresponding to the prompts container.

Returns

public abstract boolean getRefreshGrid ()

Retrieves the flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.

public abstract ReportBean getReportBean ()

Returns the report bean associated with this report frame bean.

Returns
  • the report bean associated with this report frame bean

public abstract ReportDetailsBean getReportDetailsBean ()

Returns a ReportDetailsBean object corresponding to the report details.

Returns

public abstract String getReportEditorName ()

Retrieves the name of the current open report editor

Returns
  • The name of the current open report editor

public abstract FilterEditorBean getReportFilterEditor ()

Returns the report filter editor bean within this report frame bean.

Returns
  • the report filter editor bean within this report frame bean.

public abstract FilterElementBean getReportFilterElement ()

Returns a FilterElementBean object corresponding to the report filter.

Returns

public abstract FilterElementBean getReportLimitElement ()

public abstract String getReportStyleLocalizedName ()

This method is 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.

public abstract ResizeEditorBean getResizeEditorBean ()

Returns the resize editor bean within this report frame bean.

Returns
  • the resize editor bean within this report frame bean.

public abstract SubscriptionEditorBean getSchedulesEditorBean ()

This method is deprecated.
No longer used by the Application

Returns the Subscription editor bean to use with web Subscriptions.

Returns
  • the Subscription editor bean to use with web Subscriptions.

public abstract SubscriptionEditorBean getSendNowEditorBean ()

This method is deprecated.
No longer used by the Application

Returns the Subscription editor bean to use with Send Now feature.

Returns
  • the Subscription editor bean to use with Send Now feature.

public abstract SortEditorBean getSortEditorBean ()

Returns the sort editor bean within this report frame bean.

Returns
  • the sort editor bean within this report frame bean.

public abstract SubscriptionEditorBean getSubscriptionsEditorBean ()

This method is deprecated.
No longer used by the Application

Returns the Subscription editor bean to use with Narrowcast Subscriptions.

Returns
  • the Subscription editor bean to use with Narrowcast Subscriptions.

public abstract FilterEditorBean getViewFilterEditor ()

Returns the view filter editor bean within this report frame bean.

Returns
  • the view filter editor bean within this report frame bean.

public abstract FilterElementBean getViewFilterElement ()

Returns a FilterElementBean object corresponding to the view filter.

Returns

public abstract FilterElementBean getViewLimitElement ()

public abstract boolean isNoActionFlagRemoved ()

Returns
  • whether we have just removed the noAction flag from the executionFlags when switch a report from design mode to view mode

public abstract boolean isReportToolbarEnabled ()

Returns true if the report toolbar should be enabled

Returns
  • isReportToolbarEnabled

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

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

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

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

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

public abstract void setReportEditorName (String value)

Sets the name of the report editor to be open

Parameters
value The name of the report editor to be open

public abstract void setXMLStatus (int value)

Sets the EnumRequestStatus status of the bean.

Parameters
value The XML status value ofor this bean.