public interface

SaveAsBean

implements AppComponent FolderObjectExplorerBean RequestPersistable
com.microstrategy.web.app.beans.SaveAsBean

Class Overview

This bean holds the data required for the Save As page. The state of the bean is made up by the the type you want to save the report as. It can be Report/Filter/Template. The folder where the user wants to save the object is also the part of the state.

Summary

Constants
String SAVE_AS_CONVERT_ANALYSIS Indicates that we came to the save page while creating a Flash dashboard.
String SAVE_AS_CONVERT_DOCUMENT Indicates that we came to the save page while creating a document from a report and the report needs to be saved before being converted to a document.
String SAVE_AS_CONVERT_HTML5_ANALYSIS Indicates that we came to the save page while creating an Html5 dashboard.
String SAVE_AS_EXPORT_AS_MSTR Indicates that we came to the save page while exporting as mstr.
String SAVE_AS_EXPORT_MSTR Indicates that we came to the save page while exporting dashboard to .mstr file.
String SAVE_AS_FROM_REPORT Indicates that we came to the save page from the report page.
String SAVE_AS_NC_CACHE_CUBE_UPDATE Indicates that we came to the save page while creating an cache/cube update subscription.
String SAVE_AS_NC_FILE_SUBSCRIPTIONS Indicates that we came to the save page while creating a file subscription.
String SAVE_AS_NC_FTP_SUBSCRIPTIONS Indicates that we came to the save page while creating a printFTP subscription.
String SAVE_AS_NC_PRINT_SUBSCRIPTIONS Indicates that we came to the save page while creating a print subscription.
String SAVE_AS_NC_SENDNOW Indicates that we came to the save page while creating a send now subscription.
String SAVE_AS_NC_SUBSCRIPTIONS Indicates that we came to the save page while creating an email subscription.
String SAVE_AS_OPEN_NEW Indicates that we came to the save page while opening a new report/document.
String SAVE_AS_PERSONAL_VIEW
String SAVE_AS_SHARE_EDITOR Indicates that we came to the save page from share editor.
String SAVE_AS_WEB_ALERT Indicates that we came to the save page while creating an email notification.
String SAVE_AS_WEB_ALERT_MOBILE Indicates that we came to the save page while creating a mobile notification.
String SAVE_AS_WEB_MOBILE_SCHEDULING Indicates that we came to the save page while creating a mobile subscription.
String SAVE_AS_WEB_SCHEDULING Indicates that we came to the save page while creating a web subscription.
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract String getFilterTemplateYahooPathStyle()
Returns the name of the style which we will use to render the yahoo path when we are saving a filter or a template.
abstract FolderBean getFolderBean()
Returns the folder bean among the children of the save as bean.
abstract String getFolderContentStyle()
Returns the name of the style which we will use to render the folder contents.
abstract String getFolderObjectID()
abstract boolean getIsFromDesignMode()
abstract boolean getIsFromPrompt()
Returns whether the save as bean comes from a page which was waiting from user input.
abstract boolean getIsObjectOverWritten()
abstract String getParentFolderID()
Returns the parent folder ID of the report to be saved.
abstract ReportBean getReportBean()
Returns the report bean among the children of the save as bean.
abstract String getReportYahooPathStyle()
Returns the name of the style which we will use to render the yahoo path when we are saving a report.
abstract boolean getSaveAs8iWarning()
Returns true if you are trying to save a 7i report with a new 8i OLAP services report.
abstract boolean getSaveAsChangeLinkedObjects()
Returns true if you want to change the linked objects.
abstract boolean getSaveAsEmbedModifiedObjects()
Returns true if you want to embed the modified objects.
abstract String getSaveAsFolder()
Returns the highlighted folder where the report is going to be saved.
abstract String getSaveAsNewReportID()
Returns the report Id of the newly saved saved report.
abstract String getSaveAsNewReportName()
Returns the report name of the newly saved saved report.
abstract boolean getSaveAsObjectDuplicate()
Returns true if the object that you are trying to save already exists in the location you are trying to save with the same type that you are trying to save.
abstract boolean getSaveAsObjectModified()
Returns true if the object you are saving modifies some of the linked objects.
abstract boolean getSaveAsObjectSaved()
Returns true if the object is saved successfully.
abstract String getSaveAsObjectType()
Returns the selected tab.
abstract String getSaveAsOrigin()
Returns the string which indicates as to where have we come to the save as page from.
abstract String getSaveAsOriginPath()
Returns the origin bean path in previous page where we come to this save as page.
abstract String getSaveAsOriginTarget()
abstract boolean getShowContinueBtn()
Returns the boolean which indicates whether the Continue button for the Original Report should be displayed.
abstract int getXMLStatus()
Returns the EnumRequestStatus status of the bean.
abstract void setDefaultSaveAsFolder(String sFolderID)
Sets the value of the Save As System Folder based on the parent folder Id of the report.
abstract void setFilterTemplateYahooPathStyle(String value)
Sets the name of the style used to render the yahoo path when saving a filter or a template.
abstract void setFolderContentStyle(String value)
Sets the name of the style used to render the the folder contents.
abstract void setFolderObjectID(String _objectID)
abstract void setIsFromDesignMode(boolean isFromDesignMode)
abstract void setIsFromPrompt(boolean prompt)
Sets this flag to indicate whether we come here from waiting for user input.
abstract void setIsObjectOverWritten(boolean isOverWritten)
abstract void setParentFolderID(String parentFolderID)
Sets the parent folderID of the report to be saved.
abstract void setReportYahooPathStyle(String value)
Sets the name of the style used to render the yahoo path when saving a report.
abstract void setSaveAs8iWarning(boolean object8iWarning)
Sets the flag to true 8i warning flag to true if you are trying to save a 7i report with a new 8i OLAP services report.
abstract void setSaveAsChangeLinkedObjects(boolean changeLinkedObject)
Set to true if you want to change the linked objects.
abstract void setSaveAsEmbedModifiedObjects(boolean embedModifiedObject)
Set to true if you want to embed the modified objects.
abstract void setSaveAsFolder(String saveAsFolder)
Sets the highlighted folder where the report is going to be saved.
abstract void setSaveAsNewReportID(String saveAsReportID)
Sets the report Id of the newly saved report.
abstract void setSaveAsNewReportName(String saveAsReportName)
Sets the report name of the newly saved report.
abstract void setSaveAsObjectDuplicate(boolean objectDuplicate)
Sets the Object Duplicate flag to true if the object already exists.
abstract void setSaveAsObjectModified(boolean objectModified)
Sets the Object Modified flag to true if one or more of the embedded objects of the report are being modified as a result of the save.
abstract void setSaveAsObjectSaved(boolean objectSaved)
Sets the Object Saved flag to true if the object is saved successfully.
abstract void setSaveAsObjectType(String saveAsObjectType)
Sets the selected tab.
abstract void setSaveAsOrigin(String value)
Sets the string which indicates as to where have we come to the save as page from.
abstract void setSaveAsOriginPath(String path)
Sets the origin bean path in previous page where we come to this save as page.
abstract void setSaveAsOriginTarget(String target)
abstract void setShowContinueBtn(boolean value)
Sets the boolean which indicates whether the Continue button for the Original Report should be displayed.
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.FolderObjectExplorerBean
From interface com.microstrategy.web.app.beans.ObjectExplorerBean
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 SAVE_AS_CONVERT_ANALYSIS

Indicates that we came to the save page while creating a Flash dashboard.

Constant Value: "15"

public static final String SAVE_AS_CONVERT_DOCUMENT

Indicates that we came to the save page while creating a document from a report and the report needs to be saved before being converted to a document. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "7"

public static final String SAVE_AS_CONVERT_HTML5_ANALYSIS

Indicates that we came to the save page while creating an Html5 dashboard.

Constant Value: "16"

public static final String SAVE_AS_EXPORT_AS_MSTR

Indicates that we came to the save page while exporting as mstr. More information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "12"

public static final String SAVE_AS_EXPORT_MSTR

Indicates that we came to the save page while exporting dashboard to .mstr file. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "14"

public static final String SAVE_AS_FROM_REPORT

Indicates that we came to the save page from the report page. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "0"

public static final String SAVE_AS_NC_CACHE_CUBE_UPDATE

Indicates that we came to the save page while creating an cache/cube update subscription. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "17"

public static final String SAVE_AS_NC_FILE_SUBSCRIPTIONS

Indicates that we came to the save page while creating a file subscription. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "4"

public static final String SAVE_AS_NC_FTP_SUBSCRIPTIONS

Indicates that we came to the save page while creating a printFTP subscription. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "12"

public static final String SAVE_AS_NC_PRINT_SUBSCRIPTIONS

Indicates that we came to the save page while creating a print subscription. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "5"

public static final String SAVE_AS_NC_SENDNOW

Indicates that we came to the save page while creating a send now subscription. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "2"

public static final String SAVE_AS_NC_SUBSCRIPTIONS

Indicates that we came to the save page while creating an email subscription. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "1"

public static final String SAVE_AS_OPEN_NEW

Indicates that we came to the save page while opening a new report/document. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "13"

public static final String SAVE_AS_PERSONAL_VIEW

Constant Value: "10"

public static final String SAVE_AS_SHARE_EDITOR

Indicates that we came to the save page from share editor. More information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "11"

public static final String SAVE_AS_WEB_ALERT

Indicates that we came to the save page while creating an email notification. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "8"

public static final String SAVE_AS_WEB_ALERT_MOBILE

Indicates that we came to the save page while creating a mobile notification. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "9"

public static final String SAVE_AS_WEB_MOBILE_SCHEDULING

Indicates that we came to the save page while creating a mobile subscription. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "6"

public static final String SAVE_AS_WEB_SCHEDULING

Indicates that we came to the save page while creating a web subscription. For more information @see SaveAsBean#getSaveAsOrigin()

Constant Value: "3"

Public Methods

public abstract String getFilterTemplateYahooPathStyle ()

Returns the name of the style which we will use to render the yahoo path when we are saving a filter or a template.

Returns
  • The name of the style which we will use to render the yahoo path when we are saving a filter or a template.

public abstract FolderBean getFolderBean ()

Returns the folder bean among the children of the save as bean.

Returns
  • The folder bean among the children of the save as bean.

public abstract String getFolderContentStyle ()

Returns the name of the style which we will use to render the folder contents.

Returns
  • The name of the style which we will use to render the the folder contents.

public abstract String getFolderObjectID ()

public abstract boolean getIsFromDesignMode ()

public abstract boolean getIsFromPrompt ()

Returns whether the save as bean comes from a page which was waiting from user input.

Returns
  • Returns true when we come from a prompting page. Default value is false.

public abstract boolean getIsObjectOverWritten ()

public abstract String getParentFolderID ()

Returns the parent folder ID of the report to be saved.

Returns
  • Parent folder ID of the report to be saved.

public abstract ReportBean getReportBean ()

Returns the report bean among the children of the save as bean.

Returns
  • The report bean among the children of the save as bean.

public abstract String getReportYahooPathStyle ()

Returns the name of the style which we will use to render the yahoo path when we are saving a report.

Returns
  • The name of the style which we will use to render the yahoo path when we are saving a report.

public abstract boolean getSaveAs8iWarning ()

Returns true if you are trying to save a 7i report with a new 8i OLAP services report.

Returns
  • true if you are trying to save a 7i report with a new 8i OLAP services report.

public abstract boolean getSaveAsChangeLinkedObjects ()

Returns true if you want to change the linked objects. This will be the case when the object you are saving modifies some of the linked objects.

Returns
  • true if you want to change linked objects.

public abstract boolean getSaveAsEmbedModifiedObjects ()

Returns true if you want to embed the modified objects. This will be the case when the object you are saving modifies some of the linked objects.

Returns
  • true if you want to embed the modified objects.

public abstract String getSaveAsFolder ()

Returns the highlighted folder where the report is going to be saved. It can be one among DssXmlFolderNameProfileReports, DssXmlFolderNamePublicReports, DssXmlFolderNamePublicFilters, DssXmlFolderNamePublicTemplates, DssXmlFolderNameProfileOther

Returns
  • The folder where the report is going to be saved.

public abstract String getSaveAsNewReportID ()

Returns the report Id of the newly saved saved report.

Returns
  • The report ID of the newly saved report.

public abstract String getSaveAsNewReportName ()

Returns the report name of the newly saved saved report.

Returns
  • The report name of the newly saved report.

public abstract boolean getSaveAsObjectDuplicate ()

Returns true if the object that you are trying to save already exists in the location you are trying to save with the same type that you are trying to save.

Returns
  • true if the object already exists.

public abstract boolean getSaveAsObjectModified ()

Returns true if the object you are saving modifies some of the linked objects. This could happen if you change a report filter and the then save the report which in turn modifies and saves the embedded filter in the report.

Returns
  • true if the object save causes some of the embedded objects to get modified.

public abstract boolean getSaveAsObjectSaved ()

Returns true if the object is saved successfully.

Returns
  • true if the object is saved successfully.

public abstract String getSaveAsObjectType ()

Returns the selected tab. The format you want to save the report as. It can be report, filter or template. The value is from the EnumDSSXMLObjectTypes enumeration.

Returns
  • The object type of the object to be saved. It can be report, filter or template.

public abstract String getSaveAsOrigin ()

Returns the string which indicates as to where have we come to the save as page from. If it is from any of the subsciriptions (web or email) we need to go back there after the save action. This is required because there are some report manipulations which require the user to save the report first before they can subscribe to it. If it is from the document creation from report action, we need to open the converted document from the saved report after the save action on the report is completed. If such a case arises, we need to go back to the place from where the save was initiated.

Returns
  • The value which depicts as to the place from where the save action was originated from.

public abstract String getSaveAsOriginPath ()

Returns the origin bean path in previous page where we come to this save as page. When save as page is canceled, we will be taken back to the previous page. With the information about the original bean path, it make it possible to invoke events on previous page. We are using this bean path to invoke re-prompt event on origin bean, when the save as page is canceled.

public abstract String getSaveAsOriginTarget ()

public abstract boolean getShowContinueBtn ()

Returns the boolean which indicates whether the Continue button for the Original Report should be displayed.

Returns
  • The value which indicates whether the Continue button for the Original Report should be displayed.

public abstract int getXMLStatus ()

Returns the EnumRequestStatus status of the bean. By default the status of this bean is WebBeanRequestWaitingForUserInput.

Returns
  • The EnumRequestStatus of the component.

public abstract void setDefaultSaveAsFolder (String sFolderID)

Sets the value of the Save As System Folder based on the parent folder Id of the report. It can be one among DssXmlFolderNameProfileReports, DssXmlFolderNamePublicReports, DssXmlFolderNamePublicFilters, DssXmlFolderNamePublicTemplates, DssXmlFolderNameProfileOther The folder ID is accepted as an input parameter. If folder ID is null then Save As Folder is set to point to Shared Reports. The folderID has to be a child of one of the above mentioned system frolders.

Parameters
sFolderID The parent folder ID of the original report which is being saved.

public abstract void setFilterTemplateYahooPathStyle (String value)

Sets the name of the style used to render the yahoo path when saving a filter or a template.

Parameters
value The name of the style used to render the yahoo path when saving a filter or a template.

public abstract void setFolderContentStyle (String value)

Sets the name of the style used to render the the folder contents.

Parameters
value The name of the style used to render the folder contents.

public abstract void setFolderObjectID (String _objectID)

public abstract void setIsFromDesignMode (boolean isFromDesignMode)

public abstract void setIsFromPrompt (boolean prompt)

Sets this flag to indicate whether we come here from waiting for user input. Save as bean may behave differently based on this flag. For example, when save procedure canceled, save as bean may return the previous page and reopen those prompts.

Parameters
prompt true means we come from a prompting page, otherwise false.

public abstract void setIsObjectOverWritten (boolean isOverWritten)

public abstract void setParentFolderID (String parentFolderID)

Sets the parent folderID of the report to be saved. This is the folder to which the folder browser on the save as page will default to.

Parameters
parentFolderID The folder ID to which the report which is being saved belongs to.

public abstract void setReportYahooPathStyle (String value)

Sets the name of the style used to render the yahoo path when saving a report.

Parameters
value The name of the style used to render the yahoo path when saving a report.

public abstract void setSaveAs8iWarning (boolean object8iWarning)

Sets the flag to true 8i warning flag to true if you are trying to save a 7i report with a new 8i OLAP services report.

Parameters
object8iWarning Set this to true if trying to oevrwrite old 7i report with new 8i report.

public abstract void setSaveAsChangeLinkedObjects (boolean changeLinkedObject)

Set to true if you want to change the linked objects. This will be the case when the object you are saving modifies some of the linked objects.

Parameters
changeLinkedObject Boolean flag set to true if you want to change linked objects.

public abstract void setSaveAsEmbedModifiedObjects (boolean embedModifiedObject)

Set to true if you want to embed the modified objects. This will be the case when the object you are saving modifies some of the linked objects.

Parameters
embedModifiedObject Boolean flag set to true if you want to embed the modified objects.

public abstract void setSaveAsFolder (String saveAsFolder)

Parameters
saveAsFolder The system folder to which the new saved report is going to belong to.

public abstract void setSaveAsNewReportID (String saveAsReportID)

Sets the report Id of the newly saved report.

Parameters
saveAsReportID The ID of the newly saved report.

public abstract void setSaveAsNewReportName (String saveAsReportName)

Sets the report name of the newly saved report.

Parameters
saveAsReportName The name of the newly saved report.

public abstract void setSaveAsObjectDuplicate (boolean objectDuplicate)

Sets the Object Duplicate flag to true if the object already exists.

Parameters
objectDuplicate Set this to true if the object being saved already exists at the same location.

public abstract void setSaveAsObjectModified (boolean objectModified)

Sets the Object Modified flag to true if one or more of the embedded objects of the report are being modified as a result of the save.

Parameters
objectModified Boolean flag which indicates if one or more objects are getting modified as a result of the save.

public abstract void setSaveAsObjectSaved (boolean objectSaved)

Sets the Object Saved flag to true if the object is saved successfully.

Parameters
objectSaved Boolean value to indicate if the object is saved successfully.

public abstract void setSaveAsObjectType (String saveAsObjectType)

Sets the selected tab. The format you want to save the report as. This can be report, filter or template. The value is from the EnumDSSXMLObjectTypes enumeration.

Parameters
saveAsObjectType The type of the object that you want to save the report as. It can be report, filter or template.

public abstract void setSaveAsOrigin (String value)

Sets the string which indicates as to where have we come to the save as page from. If it is from any of the subsciriptions (web or email) we need to go back there after the save action. This is required because there are some report manipulations which require the user to save the report first before they can subscribe to it. If such a case arises, we need to go back to the place from where the save was initiated.

Parameters
value The value which indicates the origin of the save as action.

public abstract void setSaveAsOriginPath (String path)

Sets the origin bean path in previous page where we come to this save as page.

public abstract void setSaveAsOriginTarget (String target)

public abstract void setShowContinueBtn (boolean value)

Sets the boolean which indicates whether the Continue button for the Original Report should be displayed.

Parameters
value The value which indicates whether the Continue button for the Original Report should be displayed.

public abstract void setXMLStatus (int value)

Sets the EnumRequestStatus status of the bean. By default the status of this bean is WebBeanRequestWaitingForUserInput.

Parameters
value The XML status value ofor this bean.