public class

ReportSetFlagsAddOn

extends AbstractAppAddOn
java.lang.Object
   ↳ com.microstrategy.web.app.addons.AbstractAppAddOn
     ↳ com.microstrategy.web.app.addons.ReportSetFlagsAddOn

Class Overview

Title: ReportSetFlagsAddOn.

Description: This add on takes care of setting the required result flags on the report bean. This add on acts on all the report beans on a page.

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

Summary

Public Constructors
ReportSetFlagsAddOn()
Public Methods
String getAddOnDescription()
boolean getUseTerseElementIDs()
static boolean isCreateMode(ReportBean rb)
This method checks whether it's create mode.
static boolean isDesignMode(ReportBean rb)
This method checks whether it's design mode.
static boolean isExecuteMode(ReportBean rb)
This method checks whether it's execute mode
void postCollectData(PageComponent page)
Executes post collectData operations.
void preCollectData(PageComponent page)
This is the main method of the add on which executes the add on.
void setAddToInboxBeforeCollectData(boolean value)
Set to true if we want to add the message automatically to inbox before the collect data.
void setAdvThresholdEditorName(String advThresholdEditorName)
void setEmailAlertEditorName(String emailAlertEditorName)
void setEventOptimizationFile(String value)
Sets the location of the event based flag optimization definition file
void setMobileAlertEditorName(String mobileAlertEditorName)
void setPromptCreateReportStyle(String value)
Sets the name of the PromptCreateReportStyle
void setReportExecutionFlags(ReportBean rb, RequestKeys keys)
Sets the execution flags on the report bean.
void setUseTerseElementIDs(boolean useTerse)
void setVisThresholdEditorName(String visThresholdEditorName)
Protected Methods
static void addToInboxAfterCollectData(ReportBean rb, Preferences prefs, RequestKeys keys)
This method adds the report to the history list only when the user clicks on the execute button if the AddToInboxBeforeCollectData is false.
void optimizeEvent(ReportBean rb, EventFlagList eventInfo)
optimizes the result and execution flags found in the eventOptimizationFlags.xml
void optimizeFlags(ReportBean rb)
optimizes the result and execution flags found in the eventOptimizationFlags.xml
static void setAddToInbox(ReportBean rb, Preferences prefs)
This method sets the saveToInbox on the report bean.
static void setReportResultFlags(ReportBean rb, Preferences prefs, boolean includeThresholdDef)
Sets the result flags on the report bean.
static void setReportResultFlags(ReportBean rb, Preferences prefs)
Sets the result flags on the report bean.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.addons.AbstractAppAddOn
From class java.lang.Object
From interface com.microstrategy.web.app.addons.AppAddOns

Public Constructors

public ReportSetFlagsAddOn ()

Public Methods

public String getAddOnDescription ()

See Also

public boolean getUseTerseElementIDs ()

public static boolean isCreateMode (ReportBean rb)

This method checks whether it's create mode.

Parameters
rb the report bean
Returns
  • boolean true if in create mode

public static boolean isDesignMode (ReportBean rb)

This method checks whether it's design mode.

Parameters
rb the report bean
Returns
  • boolean true if in design mode

public static boolean isExecuteMode (ReportBean rb)

This method checks whether it's execute mode

Parameters
rb the report bean
Returns
  • boolean true if in execute mode

public void postCollectData (PageComponent page)

Executes post collectData operations.

See Also

public void preCollectData (PageComponent page)

This is the main method of the add on which executes the add on. This has to be a static method.

Parameters
page is the PageComponent.
See Also

public void setAddToInboxBeforeCollectData (boolean value)

Set to true if we want to add the message automatically to inbox before the collect data. If this value is set to false we will add the message automatically to inbox after the collect data only when the user chooses to view the report data. In that case the history list will never have reports which are waiting for user input (i.e: Prompted state)

Parameters
value true if we want to add the message automatically to inbox before the collect data.

public void setAdvThresholdEditorName (String advThresholdEditorName)

public void setEmailAlertEditorName (String emailAlertEditorName)

public void setEventOptimizationFile (String value)

Sets the location of the event based flag optimization definition file

Parameters
value name of the eventOptimizationFile

public void setMobileAlertEditorName (String mobileAlertEditorName)

public void setPromptCreateReportStyle (String value)

Sets the name of the PromptCreateReportStyle

Parameters
value name of the PromptCreateReportStyle

public void setReportExecutionFlags (ReportBean rb, RequestKeys keys)

Sets the execution flags on the report bean.

Parameters
rb the report bean
keys The request keys
Throws
WebBeanException

public void setUseTerseElementIDs (boolean useTerse)

public void setVisThresholdEditorName (String visThresholdEditorName)

Protected Methods

protected static void addToInboxAfterCollectData (ReportBean rb, Preferences prefs, RequestKeys keys)

This method adds the report to the history list only when the user clicks on the execute button if the AddToInboxBeforeCollectData is false.

Parameters
rb the report bean
prefs The Preferences object
keys The request keys

protected void optimizeEvent (ReportBean rb, EventFlagList eventInfo)

optimizes the result and execution flags found in the eventOptimizationFlags.xml

Parameters
rb ReportBean
eventInfo EventFlagList

protected void optimizeFlags (ReportBean rb)

optimizes the result and execution flags found in the eventOptimizationFlags.xml

Parameters
rb ReportBean

protected static void setAddToInbox (ReportBean rb, Preferences prefs)

This method sets the saveToInbox on the report bean.

Parameters
rb the report bean
prefs The Preferences object

protected static void setReportResultFlags (ReportBean rb, Preferences prefs, boolean includeThresholdDef)

Sets the result flags on the report bean.

Parameters
rb the report bean
prefs The Preferences object
Throws
WebBeanException

protected static void setReportResultFlags (ReportBean rb, Preferences prefs)

Sets the result flags on the report bean.

Parameters
rb the report bean
prefs The Preferences object
Throws
WebBeanException