public class

SaveAsRWTransform

extends SaveAsReportTransform
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
                     ↳ com.microstrategy.web.app.transforms.SaveAsRWTransform

Class Overview

This transform renders the save as dialog to the user.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.SaveAsReportTransform
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
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.SaveAsReportTransform
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
SaveAsRWTransform()
Default constructor.
Public Methods
String getConfirmationTitle()
Return the confirmation title for the save as confirmation dialog
String getErrorMessage(int errorCode, String defaultMessage)
Returns the error message for the transform, based on the exception.
WebEvent getExecuteEvent()
Obtain an instance of the WebEvent to use for executing the object that has just been saved
void initializeTransform(Transformable data)
Initializes properties of this transform required for the proper generation of the HTML to present to the user.
void renderAdvancedOptionsDialog(MarkupOutput out)
Generates the Advanced Options dialog in the Save As page
void renderConfirmationButtonBar(MarkupOutput out)
Renders the confirmation buttons to the MarkupOutput instance
void renderErrorButton(MarkupOutput out)
Renders the reexecute event button Transfrom will override it if necessary
void renderLanguagesOptions(MarkupOutput out)
This method overwrites the parent by rendering languages options specific to Report Writing objects.
void renderOptions(MarkupOutput out)
Renders the prompt and/or linked filter template options as the case may be.
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 renderPromptOptions(MarkupOutput out)
This method overwrites the parent by rendering prompt options specific to Report Writing objects.
void renderSaveAsAdvancedOptions(MarkupOutput out)
Renders the advanced options section if there's any to show to the user.
void renderSaveAsTabs(MarkupOutput out)
This method overwrites the parent by not rendering any tab information.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting default attribute information
WebEvent getCancelOverwriteEvent()
Obtain an instance of the WebEvent to use for cancelling the overwritting of the new object
WebEvent getRepromptEvent()
WebEvent getSaveEvent()
Obtain an instance of the WebEvent to use for saving the new object
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.SaveAsReportTransform
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

Public Constructors

public SaveAsRWTransform ()

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

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 renderAdvancedOptionsDialog (MarkupOutput out)

Generates the Advanced Options dialog in the Save As page

Parameters
out MarkupOutput instance with the output

public void renderConfirmationButtonBar (MarkupOutput out)

Renders the confirmation buttons to the MarkupOutput instance

Parameters
out MarkupOutput instance with the output

public void renderErrorButton (MarkupOutput out)

Renders the reexecute event button Transfrom will override it if necessary

public void renderLanguagesOptions (MarkupOutput out)

This method overwrites the parent by rendering languages options specific to Report Writing objects.

Parameters
out MarkupOutput instance with the output by this transoform

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 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 renderPromptOptions (MarkupOutput out)

This method overwrites the parent by rendering prompt options specific to Report Writing objects.

Parameters
out MarkupOutput instance with the output by this transoform

public void renderSaveAsAdvancedOptions (MarkupOutput out)

Renders the advanced options section if there's any to show to the user. For this, conditions such as is propmted report and what type of object is being saved are tested. The renderPromptOptions and renderFilterTemplateOptions methods are called for rendering the settings to the user.

Parameters
out MarkupOutput instance with the output by this transoform

public void renderSaveAsTabs (MarkupOutput out)

This method overwrites the parent by not rendering any tab information.

Parameters
out MarkupOutput instance with the output by this transoform

Protected Methods

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 WebEvent getCancelOverwriteEvent ()

Obtain an instance of the WebEvent to use for cancelling the overwritting of the new object

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

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 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 transoform
saveEvent The event used for saving