public class

SaveAsReportTransform

extends SaveAsTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
             ↳ com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
               ↳ com.microstrategy.web.app.transforms.FolderObjectExplorerTransform
                 ↳ com.microstrategy.web.app.transforms.SaveAsTransform
                   ↳ com.microstrategy.web.app.transforms.SaveAsReportTransform
Known Direct Subclasses

Class Overview

This transform renders the save as dialog to the user.

Summary

Constants
String FP_CHECK_KEEP_PROMPT Constant for the name of the checkKeepPrompt Formal Parameter.
String FP_NON_PROMPTED_EMBED_FILTER_EMBED_TEMPLATE Constant for the name of the saveNonPromptedEmbedFilterEmbedTemplate Formal Parameter.
String FP_NON_PROMPTED_EMBED_FILTER_LINKED_TEMPLATE Constant for the name of the saveNonPromptedEmbedFilterLinkedTempalte Formal Parameter.
String FP_NON_PROMPTED_FILTER Constant for the name of the saveNonPromptedFilter Formal Parameter.
String FP_NON_PROMPTED_LINKED_FILTER_EMBED_TEMPLATE Constant for the name of the saveNonPromptedLinkedFilterEmbedTempalte Formal Parameter.
String FP_NON_PROMPTED_LINKED_FILTER_LINKED_TEMPLATE Constant for the name of the saveNonPromptedLinkedFilterLinkedTempalte Formal Parameter.
String FP_NON_PROMPTED_TEMPLATE Constant for the name of the saveNonPromptedTemplate Formal Parameter.
String FP_PROMPTED_EMBED_FILTER_EMBED_TEMPLATE Constant for the name of the savePromptedEmbedFilterEmbedTemplate Formal Parameter.
String FP_PROMPTED_EMBED_FILTER_LINKED_TEMPLATE Constant for the name of the savePromptedEmbedFilterLinkedTempalte Formal Parameter.
String FP_PROMPTED_FILTER Constant for the name of the savePromptedFilter Formal Parameter.
String FP_PROMPTED_LINKED_FILTER_EMBED_TEMPLATE Constant for the name of the savePromptedLinkedFilterEmbedTempalte Formal Parameter.
String FP_PROMPTED_LINKED_FILTER_LINKED_TEMPLATE Constant for the name of the savePromptedLinkedFilterLinkedTempalte Formal Parameter.
String FP_PROMPTED_TEMPLATE Constant for the name of the savePromptedTemplate Formal Parameter.
String FP_RENDER_LINKS_ANCESTORS Constant for the name of the renderLinksAncestors Formal Parameters.
String FP_SHOW_SAVE_OPTIONS Constant for the name of the showSaveAsOptions Formal Parameter.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.SaveAsTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected ObjectBean _targetBean
public FormalParameter checkKeepPrompt In the case of a prompted report, indicates whether the simple option for keeping the reprot prompted is checked by default.
public FormalParameter renderLinksAncestors This formal parameter controls whether we display the ancestors of the Folder links in the ancestor list.
public FormalParameter saveNonPromptedEmbedFilterEmbedTemplate Value of the save as flags for a non prompted report that defines whether filter and template are embedded or linked.
public FormalParameter saveNonPromptedEmbedFilterLinkedTempalte This field is deprecated. use saveNonPromptedEmbedFilterEmbedTemplate
public FormalParameter saveNonPromptedFilter Value of the save as flags for saving a the filter of a non prompted report.
public FormalParameter saveNonPromptedLinkedFilterEmbedTempalte This field is deprecated. use saveNonPromptedEmbedFilterEmbedTemplate
public FormalParameter saveNonPromptedLinkedFilterLinkedTempalte This field is deprecated. use saveNonPromptedEmbedFilterEmbedTemplate
public FormalParameter saveNonPromptedTemplate Value of the save as flags for saving a the template of a non prompted report.
public FormalParameter savePromptedEmbedFilterEmbedTemplate Value of the save as flags for a prompted report that defines whether filter and template are embedded or linked.
public FormalParameter savePromptedEmbedFilterLinkedTempalte This field is deprecated. use savePromptedEmbedFilterEmbedTemplate
public FormalParameter savePromptedFilter Value of the save as flags for saving a the filter of a prompted report.
public FormalParameter savePromptedLinkedFilterEmbedTempalte This field is deprecated. use savePromptedEmbedFilterEmbedTemplate
public FormalParameter savePromptedLinkedFilterLinkedTempalte This field is deprecated. use savePromptedEmbedFilterEmbedTemplate
public FormalParameter savePromptedTemplate Value of the save as flags for saving a the template of a prompted report.
public FormalParameter showSaveAsOptions Flag to decide whether to show the save as options at all.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.SaveAsTransform
From class com.microstrategy.web.app.transforms.FolderObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SaveAsReportTransform()
Default constructor.
Public Methods
String getConfirmationTitle()
Return the confirmation title for the save as confirmation dialog
String getDescription()
Returns the textual description of the transform
String getErrorMessage(int errorCode, String defaultMessage)
Returns the error message for the transform, based on the exception.
void initializeTransform(Transformable data)
Initializes properties of this transform required for the proper generation of the HTML to present to the user.
void renderAdvancedCreateButtonBar(MarkupOutput out)
Renders the HTML for displaying the button bar contents for the Advanced options dialog.
void renderAdvancedOptionsDialog(MarkupOutput out)
Generates the dialog for allowing the user to define advanced save as options calls renderAdvancedPromptOptions, renderLinkOptions and renderAdvancedCreateButtonBar for displaying the fields available to the user.
void renderAdvancedPromptOptions(MarkupOutput out)
Renders the HTML for displaying the advanced save as options.
void renderConfirmationButtonBar(MarkupOutput out)
Renders the confirmation buttons to the MarkupOutput instance
void renderConfirmationSuccessfulMessage(MarkupOutput out)
Renders the confirmation title to the MarkupOutput instance
void renderEditorContents(MarkupOutput out)
Generates the dialog for allowing the user to save an object with a new name and description.
void renderErrorButton(MarkupOutput out)
Renders the reexecute event button Transfrom will override it if necessary
void renderLanguagesOptions(MarkupOutput out)
Renders the HTML for displaying the languages save as options.
void renderLinkOptions(MarkupOutput out)
Renders the HTML for displaying the linked filter template save as options.
void renderModifyConfirmationDialog(MarkupOutput out)
Renders the dialog that informs the user that the template and/or template have been modified and asks them if they want to link to the original object
void renderOptions(MarkupOutput out)
Renders the prompt and/or linked filter template options as the case may be.
void renderOverwriteButtonBar(MarkupOutput out)
Renders the button bar for the overwrite dialog when the object that the user is trying to save already exists.
void renderOverwriteConfirmationDialog(MarkupOutput out)
Renders the dialog that informs the user that the report being saved already exists and asks users if they wish to overwrite it.
void renderOverwriteMessage(MarkupOutput out)
The message to render on the overwrite dialog when the object that the user is trying to save already exists.
void renderSaveAsTabs(MarkupOutput out)
This method renders the different tabs that enable the user to determine the object type to save, which can be either a new report, a filter or a template.
void renderSimpleOptions(MarkupOutput out)
Renders save as options such as:
  • Keep report prompted
  • Keep template and filter as linked objects
  • Button for "Advanced Options..."
boolean shouldRenderOpenParent()
Checks whether we should render the open parent link.
Protected Methods
void addLinksAsOption(SelectTag __result)
Method adds the standard shortcut links that have to be displayed after the contents of the object browser.
ArrayList generateAncestorsOptionTags()
Generates the series of option tags to add to the combo box for showing the user the possible places where the new object can be saved, based on privileges, access rights and current location of the object.
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting default attribute information
ArrayList getAncestorsOptionTags(StringBuffer indentBuffer)
WebEvent getExecuteEvent()
Obtain an instance of the WebEvent to use for executing the object that has just been saved
WebEvent getFilterTabEvent()
Obtain an instance of the WebEvent to use for switching to the Filter tab on the Save As dialog
String getObjectDescription()
Obtain the object description to use for the new object to create
WebEvent getRepromptEvent()
WebEvent getSaveEvent()
Obtain an instance of the WebEvent to use for saving the new object
WebEvent getTargetTabEvent()
Obtain an instance of the WebEvent to use for switching to the Report tab on the Save As dialog
WebEvent getTemplateTabEvent()
Obtain an instance of the WebEvent to use for switching to the Template tab on the Save As dialog
boolean hasOtherNameTranslations()
Determine if the target object to save has other name translations or not
boolean isDisplaySaveEmbeddedCheckBox()
Determine if the save embedded check box option should be rendered or not
boolean isPrompted()
Determine if the target object to save is prompted or not
void renderOverwriteSaveFlags(MarkupOutput out, WebEvent saveEvent)
Render the save as flags as hidden inputs in case of an overwrite
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.SaveAsTransform
From class com.microstrategy.web.app.transforms.FolderObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_CHECK_KEEP_PROMPT

Constant for the name of the checkKeepPrompt Formal Parameter.

See Also
Constant Value: "checkKeepPrompt"

public static final String FP_NON_PROMPTED_EMBED_FILTER_EMBED_TEMPLATE

Constant for the name of the saveNonPromptedEmbedFilterEmbedTemplate Formal Parameter.

Constant Value: "saveNonPromptedEmbedFilterEmbedTemplate"

public static final String FP_NON_PROMPTED_EMBED_FILTER_LINKED_TEMPLATE

Constant for the name of the saveNonPromptedEmbedFilterLinkedTempalte Formal Parameter.

Constant Value: "saveNonPromptedEmbedFilterLinkedTempalte"

public static final String FP_NON_PROMPTED_FILTER

Constant for the name of the saveNonPromptedFilter Formal Parameter.

Constant Value: "saveNonPromptedFilter"

public static final String FP_NON_PROMPTED_LINKED_FILTER_EMBED_TEMPLATE

Constant for the name of the saveNonPromptedLinkedFilterEmbedTempalte Formal Parameter.

Constant Value: "saveNonPromptedLinkedFilterEmbedTempalte"

public static final String FP_NON_PROMPTED_LINKED_FILTER_LINKED_TEMPLATE

Constant for the name of the saveNonPromptedLinkedFilterLinkedTempalte Formal Parameter.

Constant Value: "saveNonPromptedLinkedFilterLinkedTempalte"

public static final String FP_NON_PROMPTED_TEMPLATE

Constant for the name of the saveNonPromptedTemplate Formal Parameter.

Constant Value: "saveNonPromptedTemplate"

public static final String FP_PROMPTED_EMBED_FILTER_EMBED_TEMPLATE

Constant for the name of the savePromptedEmbedFilterEmbedTemplate Formal Parameter.

Constant Value: "savePromptedEmbedFilterEmbedTemplate"

public static final String FP_PROMPTED_EMBED_FILTER_LINKED_TEMPLATE

Constant for the name of the savePromptedEmbedFilterLinkedTempalte Formal Parameter.

Constant Value: "savePromptedEmbedFilterLinkedTempalte"

public static final String FP_PROMPTED_FILTER

Constant for the name of the savePromptedFilter Formal Parameter.

Constant Value: "savePromptedFilter"

public static final String FP_PROMPTED_LINKED_FILTER_EMBED_TEMPLATE

Constant for the name of the savePromptedLinkedFilterEmbedTempalte Formal Parameter.

Constant Value: "savePromptedLinkedFilterEmbedTempalte"

public static final String FP_PROMPTED_LINKED_FILTER_LINKED_TEMPLATE

Constant for the name of the savePromptedLinkedFilterLinkedTempalte Formal Parameter.

Constant Value: "savePromptedLinkedFilterLinkedTempalte"

public static final String FP_PROMPTED_TEMPLATE

Constant for the name of the savePromptedTemplate Formal Parameter.

Constant Value: "savePromptedTemplate"

public static final String FP_RENDER_LINKS_ANCESTORS

Constant for the name of the renderLinksAncestors Formal Parameters.

Constant Value: "renderLinksAncestors"

public static final String FP_SHOW_SAVE_OPTIONS

Constant for the name of the showSaveAsOptions Formal Parameter.

Constant Value: "showSaveAsOptions"

Fields

protected ObjectBean _targetBean

public FormalParameter checkKeepPrompt

In the case of a prompted report, indicates whether the simple option for keeping the reprot prompted is checked by default.

public FormalParameter renderLinksAncestors

This formal parameter controls whether we display the ancestors of the Folder links in the ancestor list.

public FormalParameter saveNonPromptedEmbedFilterEmbedTemplate

Value of the save as flags for a non prompted report that defines whether filter and template are embedded or linked.
This flag will be used only in case the flag to show the options (showSaveAsOptions) for saving a report are not shown.
The value comes from EnumDSSXMLReportSaveAsFlags

public FormalParameter saveNonPromptedEmbedFilterLinkedTempalte

This field is deprecated.
use saveNonPromptedEmbedFilterEmbedTemplate

Value of the save as flags for a non prompted report with embedded or linked filter and linked template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

public FormalParameter saveNonPromptedFilter

Value of the save as flags for saving a the filter of a non prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

public FormalParameter saveNonPromptedLinkedFilterEmbedTempalte

This field is deprecated.
use saveNonPromptedEmbedFilterEmbedTemplate

Value of the save as flags for a non prompted report with linked filter and embedded template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

public FormalParameter saveNonPromptedLinkedFilterLinkedTempalte

This field is deprecated.
use saveNonPromptedEmbedFilterEmbedTemplate

Value of the save as flags for a non prompted report with linked filter and template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

public FormalParameter saveNonPromptedTemplate

Value of the save as flags for saving a the template of a non prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

public FormalParameter savePromptedEmbedFilterEmbedTemplate

Value of the save as flags for a prompted report that defines whether filter and template are embedded or linked.
This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.
The value comes from EnumDSSXMLReportSaveAsFlags

public FormalParameter savePromptedEmbedFilterLinkedTempalte

This field is deprecated.
use savePromptedEmbedFilterEmbedTemplate

Value of the save as flags for a prompted report with embedded filter and linked template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

public FormalParameter savePromptedFilter

Value of the save as flags for saving a the filter of a prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

public FormalParameter savePromptedLinkedFilterEmbedTempalte

This field is deprecated.
use savePromptedEmbedFilterEmbedTemplate

Value of the save as flags for a prompted report with linked filter and embedded template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

public FormalParameter savePromptedLinkedFilterLinkedTempalte

This field is deprecated.
use savePromptedEmbedFilterEmbedTemplate

Value of the save as flags for a prompted report with linked filter and template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

public FormalParameter savePromptedTemplate

Value of the save as flags for saving a the template of a prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

public FormalParameter showSaveAsOptions

Flag to decide whether to show the save as options at all. If this flag is set to false, only then will we use all the other save as flag related formal parameters.

Public Constructors

public SaveAsReportTransform ()

Default constructor. Initializes formal parameters.

Public Methods

public String getConfirmationTitle ()

Return the confirmation title for the save as confirmation dialog

Returns
  • The confirmation title for the save as confirmation dialog

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public String getErrorMessage (int errorCode, String defaultMessage)

Returns the error message for the transform, based on the exception. By default returns:

 getDescriptor(640) + " " + getDescriptor(641) + "
"; //Descriptors: Your request could not be processed due to a server error. | Please try again. If the error persists, contact the server administrator.

Parameters
errorCode The error code for which we need the error message
defaultMessage the default error message to be shown
Returns
  • The error message.

public void initializeTransform (Transformable data)

Initializes properties of this transform required for the proper generation of the HTML to present to the user.

Parameters
data Transformable instance to transform with this class.

public void renderAdvancedCreateButtonBar (MarkupOutput out)

Renders the HTML for displaying the button bar contents for the Advanced options dialog.

Parameters
out MarkupOutput instance with the output by this transform

public void renderAdvancedOptionsDialog (MarkupOutput out)

Generates the dialog for allowing the user to define advanced save as options calls renderAdvancedPromptOptions, renderLinkOptions and renderAdvancedCreateButtonBar for displaying the fields available to the user.

Parameters
out MarkupOutput instance with the output by this transform

public void renderAdvancedPromptOptions (MarkupOutput out)

Renders the HTML for displaying the advanced save as options. These options are especially linked with the prompt options.

Parameters
out MarkupOutput instance with the output by this transform

public void renderConfirmationButtonBar (MarkupOutput out)

Renders the confirmation buttons to the MarkupOutput instance

Parameters
out MarkupOutput instance with the output

public void renderConfirmationSuccessfulMessage (MarkupOutput out)

Renders the confirmation title to the MarkupOutput instance

Parameters
out MarkupOutput instance with the output

public void renderEditorContents (MarkupOutput out)

Generates the dialog for allowing the user to save an object with a new name and description. Internally calls renderSaveAsTabs for displaying the fields available to the user.

Parameters
out MarkupOutput instance with the output by this transform

public void renderErrorButton (MarkupOutput out)

Renders the reexecute event button Transfrom will override it if necessary

public void renderLanguagesOptions (MarkupOutput out)

Renders the HTML for displaying the languages save as options.

Parameters
out MarkupOutput instance with the output by this transform

public void renderLinkOptions (MarkupOutput out)

Renders the HTML for displaying the linked filter template save as options.

Parameters
out MarkupOutput instance with the output by this transform

public void renderModifyConfirmationDialog (MarkupOutput out)

Renders the dialog that informs the user that the template and/or template have been modified and asks them if they want to link to the original object

public void renderOptions (MarkupOutput out)

Renders the prompt and/or linked filter template options as the case may be.

Parameters
out MarkupOutput instance with the output by this transoform

public void renderOverwriteButtonBar (MarkupOutput out)

Renders the button bar for the overwrite dialog when the object that the user is trying to save already exists.

Parameters
out MarkupOutput instance with the output by this transoform

public void renderOverwriteConfirmationDialog (MarkupOutput out)

Renders the dialog that informs the user that the report being saved already exists and asks users if they wish to overwrite it.

public void renderOverwriteMessage (MarkupOutput out)

The message to render on the overwrite dialog when the object that the user is trying to save already exists.

Parameters
out MarkupOutput instance with the output by this transoform

public void renderSaveAsTabs (MarkupOutput out)

This method renders the different tabs that enable the user to determine the object type to save, which can be either a new report, a filter or a template.

Parameters
out MarkupOutput instance with the output by this transform

public void renderSimpleOptions (MarkupOutput out)

Renders save as options such as:

  • Keep report prompted
  • Keep template and filter as linked objects
  • Button for "Advanced Options..."

Parameters
out MarkupOutput instance with the output by this transform

public boolean shouldRenderOpenParent ()

Checks whether we should render the open parent link. Will return false if the current folder is a link and renderLinksAncestors is false.

Protected Methods

protected void addLinksAsOption (SelectTag __result)

Method adds the standard shortcut links that have to be displayed after the contents of the object browser. These links are shortcuts to the Attributes, Metrics, Hierarchies ... folders

protected ArrayList generateAncestorsOptionTags ()

Generates the series of option tags to add to the combo box for showing the user the possible places where the new object can be saved, based on privileges, access rights and current location of the object.

Returns
  • an array of Tag instances corresponding to the different OPTION that will be provided to the user.

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting default attribute information

Parameters
event WebEvent instance to use as base for the link
Returns
  • AnchorTag instance initialized with the event information

protected ArrayList getAncestorsOptionTags (StringBuffer indentBuffer)

protected WebEvent getExecuteEvent ()

Obtain an instance of the WebEvent to use for executing the object that has just been saved

Returns
  • WebEvent instance initialized, null if it could not be created.

protected WebEvent getFilterTabEvent ()

Obtain an instance of the WebEvent to use for switching to the Filter tab on the Save As dialog

Returns
  • WebEvent instance initialized, null if it could not be created.

protected String getObjectDescription ()

Obtain the object description to use for the new object to create

Returns
  • String value with the description of the new object to be created. It can come from the original object or whatever the user might had previously specified for it.

protected WebEvent getRepromptEvent ()

protected WebEvent getSaveEvent ()

Obtain an instance of the WebEvent to use for saving the new object

Returns
  • WebEvent instance initialized, null if it could not be created.

protected WebEvent getTargetTabEvent ()

Obtain an instance of the WebEvent to use for switching to the Report tab on the Save As dialog

Returns
  • WebEvent instance initialized, null if it could not be created.

protected WebEvent getTemplateTabEvent ()

Obtain an instance of the WebEvent to use for switching to the Template tab on the Save As dialog

Returns
  • WebEvent instance initialized, null if it could not be created.

protected boolean hasOtherNameTranslations ()

Determine if the target object to save has other name translations or not

Returns
  • boolean value indicating if the target object to save has other name translations or not

protected boolean isDisplaySaveEmbeddedCheckBox ()

Determine if the save embedded check box option should be rendered or not

Returns
  • boolean value indicating if the check box should become available or not, based on privileges and if the target object is prompted or not.

protected boolean isPrompted ()

Determine if the target object to save is prompted or not

Returns
  • boolean value indicating if the object is prompted or not

protected void renderOverwriteSaveFlags (MarkupOutput out, WebEvent saveEvent)

Render the save as flags as hidden inputs in case of an overwrite

Parameters
out MarkupOutput instance with the output by this transform
saveEvent The event used for saving