public interface

RWInstance

implements WebResultSetInstance
com.microstrategy.web.objects.rw.RWInstance

Class Overview

This interface represents an instance of RW report

Summary

Constants
String PROPERTY_SET_DOCUMENT
String PROPERTY_SET_FORMATTING_PAGE
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void appendNodesFilter(String units)
abstract String checkImageExist(String shaValue)
check whether the image has been stored in MD or in current instance
abstract void disablePartialCSSForGridGraph(String ggKey)
Disables the partial update of the specified object
abstract void discardState()
Discards current state.
abstract void discardState(boolean preserveChanges)
Discards current state.@ param preserveChanges indicate whether to preserve current delta changes
abstract String getCurrentLayoutKey()
Returns the current layout key.
abstract RWData getData()
Returns report data
abstract RWDataSettings getDataSettings()
Returns document data settings.
abstract RWGridGraphSettings getDefaultGridGraphSettings()
This method returns the default grid/graph settings.
abstract RWDefinition getDefinition()
Returns report definition.
abstract RWDefinition getDefinitionNoLoad()
Returns report definition or null if it is not present
abstract RWDetailsFormatter getDetailsFormatter()
Returns the details formatter object associated with this instance.
abstract RWDocumentDetails getDocumentDetails()
Return the document details object
abstract WebPropertyGroup getDocumentProperties()
Returns the properties at the document level
abstract String getElementFromGraph(String sessionID, String messageID, String nodeKey, String sliceID, int x, int y, String dpi)
Get elements from graph in document.
abstract byte[] getExcelData()
Returns data for Excel export
abstract int getExecutionMode()
Returns exectuon mode from EnumRWExecutionModes
abstract byte[] getExportCacheID()
abstract byte[] getExportData()
Retrieves from the IServer binary data for export.
abstract RWExportSettings getExportSettings()
Returns export settings object that corresponds to the current execution mode (getExecutionMode()).
abstract RWExportSettings getExportSettings(int executionMode)
Returns export settings for the given execution mode.
abstract WebGraph getGraphObject(String nodeKey)
Returns the graph definition object associated with the specified node.
abstract WebGraph getGraphObject(String nodeKey, int slicedWindowID)
Returns the graph definition object associated with the specified node.
abstract RWGridGraphSettings getGridGraphSettings(int mode)
This method returns the grid/graph settings for a specific visualization mode.
abstract WebResultSettings getGridGraphSettings()
Return a WebResultSettings object which can be used to control some of the EnumDSSXMLResult2Flags that will be used for all the RWGridGraphDef objects in the report writing document.
abstract RWIncrementalFetchSettings getIncrementalFetchSettings()
abstract boolean getIsClientAuto()
Get isClientAuto, which indicates whether the manipulation is client auto
abstract String getLastUpdate()
Returns the time and date when this document was last updated against the warehouse.
abstract String getLogMessageAsXML()
Returns log message for the current report.
abstract String getMSTRPredictedFileSize(String documentID)
Get the predicted MSTR file size for a document or a report.
abstract RWMessage getMessage()
Returns A RWMessage object for the current RW doc.
abstract RWMessage getMessage(boolean populate)
Returns A RWMessage object for the current RW doc.
abstract Set<String> getNodesFilter()
returns list of node keys those are set for the filter
abstract byte[] getPDFData()
Returns data for PDF export
abstract PersonalViewExecutionInfo getPersonalViewExecutionInfo()
Get PersonalViewExecutionInfo, which indicates if personal manipulations all applied
abstract WebPropertyGroup getProperties(String nodeKey)
returns the properties corresponding to a specific node
abstract RWManipulation getRWManipulator(boolean validateStatus)
Returns RW manipulator
abstract RWManipulation getRWManipulator()
Returns RW manipulator
abstract int getResultFilterMode()
Returns the filter mode that is currently set.
abstract RWSettings getResultSettings()
abstract String getResultsAsJson(int resultFlags)
abstract String getResultsAsJson(int resultFlags, int mode)
THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
abstract String getResultsAsXML()
Returns execution results as XML string
abstract int getSaveAsDisplayMode()
Returns the display mode for the saveAs call.
abstract int getSaveAsFlags()
Returns the flags for the saveAs call.
abstract RWSecondaryDataProviderHelper getSecondaryDataProviderHelper()
Returns a helper class for working with widget secondary data providers.
abstract boolean getSupportsUndo()
Indicate that the application using this instance supports undo/redo
abstract Set<String> getUpdatedUnits()
abstract WebVisualizationSettings getVisualizationSettings()
This method exposes the visualization settings for the RW document.
abstract String importImageToDocument(String treeType, String nodeKey, String fieldKey, String fieldName, String imgName, int index, long fileSize, String imgID, String hashCode, int isEdit, InputStream data)
Import image to document
abstract String importImageToDocument(String binaryID, int blockCount, int blockIndex, int blockSize, String treeType, String nodeKey, String fieldKey, String fieldName, String imgName, int index, long fileSize, String imgID, String hashCode, int isEdit, InputStream data)
Import image to document
abstract void includeFilterUnits()
Include filter units in partial update result
abstract boolean isDirty()
Indicates whether the instance has been modified since it was first executed.
abstract boolean isMultiLayout()
Returns true if this is a multi-layout document
abstract void iterate(RWVisitor visitor, RWIterateSettings settings)
Iteration method for visiting the underlying object model.
abstract WebObjectInfo saveAs(WebFolder parentFolder, String name, String description)
Saves the current report instance, or template of the current report instance, or filter of the current report instance into the given folder with the given name and description.
abstract WebObjectInfo saveAs(WebFolder parentFolder)
Saves the current report instance, or template of the current report instance, or filter of the current report instance into the given folder with the given name and description.
abstract WebObjectInfo saveAs(WebFolder parentFolder, String name)
Saves the current report instance, or template of the current report instance, or filter of the current report instance into the given folder with the given name and description.
abstract String saveAsForManagedDataset(String folderID, String docName, String docDesc, boolean documentLevel, String reportSaveAsOptions)
abstract String saveAsForManagedDataset(String folderID, String docName, String docDesc, boolean documentLevel, String reportSaveAsOptions, IntWrapper status, int requestTimeout)
Saves managed dataset or standalone dataset within the current report instance.
abstract String saveAsSegment(WebFolder parentFolder, String name, String description, int flags, String nodeKey)
Save segment from RWD.
abstract String saveAsTheme(String folderID, String themeName, String themeDesc, int flags)
Save the document theme as a standalone object.
abstract String saveDerivedElements(String unitKey, String attId, String folderId, String name, String description, boolean overwrite)
abstract void sendExportData(IContentConsumer contentConsumer)
Streams binary export data received from IServe to a content consumer.
abstract void setControlFilter(Set<String> units)
Sets control filter
abstract void setCurrentLayoutKey(String value)
Switches to a new current layout.
abstract void setDocumentProperty(String propertySetName, String propertyName, String propertyValue)
Sets document's property
abstract void setExecutionMode(int mode)
Sets execution mode
abstract void setExportCacheID(byte[] exportCacheID)
set the exportCacheID of the instance
abstract void setGridIncrementalFetch(String unitKey, int rowMode, int rowPosition, int maxRows, int colMode, int colPosition, int maxColumns)
Sets grid incremental fetch position
abstract void setGridIncrementalFetch(String unitKey, int rowPosition, int maxRows, int colPosition, int maxColumns)
Sets grid incremental fetch position
abstract void setIsClientAuto(boolean isClientAuto)
Set isClientAuto, which indicates whether the manipulation is client auto
abstract void setNodesFilter(Set<String> units)
Sets nodes filter
abstract void setPersonalViewExecutionInfo(PersonalViewExecutionInfo pvInfo)
Set PersonalViewExecutionInfo, which indicates if personal manipulations all applied
abstract void setProperty(String unitKey, String propertySetName, String propertyName, String propertyValue)
Sets a property value for the specified unit
abstract void setResultFilterMode(int resultFilterMode)
Sets the filter mode.
abstract void setSaveAsDisplayMode(int saveAsDisplayMode)
Sets the display mode for the saveAs call.
abstract void setSaveAsFlags(int saveAsFlags)
Sets the flags for the saveAs call.
abstract void setStateID(int stateID)
set the steateID of inboxMessage of instance
abstract void setSupportsUndo(boolean value)
Sets flag indication that application using this instance supports undo/redo
abstract void setUnitsFilter(Set units)
Sets units filter
abstract void setUnitsFilterProps(Map defnFilterProps, Map dataFilterProps)
Sets the JSON properties in the units filter for the server to return.
abstract void setUpdatedObjectsFilter(Set<MojoRWUpdatedObjectsSettings> objects)
Set the partial update on object keys.
abstract void setUpdatedUnitsFilter(Set<String> nodes)
Sets update units filter
abstract void subscribe(WebSubscriptionTrigger trigger, WebSubscriptionAddress address, String subject, boolean sendNow, String customMessage, WebSubscriptionContentFormat format, boolean zip)
Subscibes a user to this document
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebResultSetInstance

Constants

public static final String PROPERTY_SET_DOCUMENT

Constant Value: "RWDocumentProperties"

public static final String PROPERTY_SET_FORMATTING_PAGE

Constant Value: "FormattingPage"

Public Methods

public abstract void appendNodesFilter (String units)

Parameters
units Adds Node key to the list. if the nodes list is empty, it creates a new HashSet before appending.

public abstract String checkImageExist (String shaValue)

check whether the image has been stored in MD or in current instance

Parameters
shaValue the SHA result of image binary stream
Returns
  • If the image exists, return the id of the image. else return a string with all zero
Throws
WebObjectsException

public abstract void disablePartialCSSForGridGraph (String ggKey)

Disables the partial update of the specified object

Parameters
ggKey The key corresponding to the grid/graph for which partial update is disabled and forces the iserver to send the entire css

public abstract void discardState ()

Discards current state.

Throws
WebObjectsException

public abstract void discardState (boolean preserveChanges)

Discards current state.@ param preserveChanges indicate whether to preserve current delta changes

Throws
WebObjectsException
WebObjectsException

public abstract String getCurrentLayoutKey ()

Returns the current layout key.

Returns
  • the current layout key.

public abstract RWData getData ()

Returns report data

Returns
  • report data
Throws
WebObjectsException

public abstract RWDataSettings getDataSettings ()

Returns document data settings.

Returns
  • document data settings.

public abstract RWGridGraphSettings getDefaultGridGraphSettings ()

This method returns the default grid/graph settings. This object can be used to change the result flags and other settings of all grids embedded in the RW document.

Returns
  • A RWGridGraphSettings object, which can be used to change the grid graph settings for all grids in the RWD.

public abstract RWDefinition getDefinition ()

Returns report definition. If the definition is not currently present in the object state, it will be loaded from the server.

Returns
  • report definition
Throws
WebObjectsException

public abstract RWDefinition getDefinitionNoLoad ()

Returns report definition or null if it is not present

Returns
  • report definition

public abstract RWDetailsFormatter getDetailsFormatter ()

Returns the details formatter object associated with this instance. To retrieve document details, the formatter should be configured to indicate which parts of the details are retrieved from the server.

public abstract RWDocumentDetails getDocumentDetails ()

Return the document details object

Throws
WebObjectsException
WebObjectsException

public abstract WebPropertyGroup getDocumentProperties ()

Returns the properties at the document level

Returns
  • the properties at the document level
Throws
WebObjectsException

public abstract String getElementFromGraph (String sessionID, String messageID, String nodeKey, String sliceID, int x, int y, String dpi)

Get elements from graph in document.

Throws
WebObjectsException

public abstract byte[] getExcelData ()

Returns data for Excel export

Returns
  • byte[] Excel data
Throws
WebObjectsException
WebObjectsException

public abstract int getExecutionMode ()

Returns exectuon mode from EnumRWExecutionModes

Returns

public abstract byte[] getExportCacheID ()

public abstract byte[] getExportData ()

Retrieves from the IServer binary data for export.

Returns
  • binary export data.
Throws
WebObjectsException
WebObjectsException

public abstract RWExportSettings getExportSettings ()

Returns export settings object that corresponds to the current execution mode (getExecutionMode()).
If the execution mode is not a known export mode, RW_MODE_PDF is assumed.
The following describes the execution mode associations, and the export settings subclass, which RWExportSettings may be cast into (if any):


It can be used as follows:

getRWInstance().setExecutionMode(EnumRWExecutionModes.RW_MODE_EXCEL);
getRWInstance().getExportSettings().setMode(EnumRWExportModes.RW_EXPORT_ALL);
byte[] data = getRWInstance().getExportData();
String stringData = new String(data, "UnicodeLittle"); // optional (this should be avoided if possible)

Returns
  • export settings object associated with the current execution mode.

public abstract RWExportSettings getExportSettings (int executionMode)

Returns export settings for the given execution mode. Note that this does not change the execution mode on the RWInstance.If the execution mode is not a known export mode, RW_MODE_PDF is assumed.

Parameters
executionMode Constant from EnumRWExecutionModes.
Returns
  • Excel export settings.
See Also

public abstract WebGraph getGraphObject (String nodeKey)

Returns the graph definition object associated with the specified node. The graph object returned should not be used for retrieving data as the sliced window ID is missing for such a graph object.

Parameters
nodeKey the key of the node.
Returns
  • the graph object.
Throws
WebObjectsException if there was an error encountered while retrieving the graph object.
IllegalArgumentException if an invalid node key is passed.

public abstract WebGraph getGraphObject (String nodeKey, int slicedWindowID)

Returns the graph definition object associated with the specified node. The graph object returned can be used for retrieving data

Parameters
nodeKey the node key
slicedWindowID the window ID of sliced graph object to be fetched.
Returns
  • the graph object.
Throws
WebObjectsException if there was an error encountered while retrieving the graph object.
IllegalArgumentException if an invalid node key or slice ID (<0) is passed

public abstract RWGridGraphSettings getGridGraphSettings (int mode)

This method returns the grid/graph settings for a specific visualization mode. This object can be used to change the result flags and other settings of all grids embedded in the RW document with their visualization view mode set to the given value.

Parameters
mode The visualization view mode that the given settings are for. If a grid has this visualization view mode, then these settings will apply, otherwise they will not.
Returns
  • A RWGridGraphSettings object, which can be used to change the grid graph settings for grids in the RWD with the given visualization mode.

public abstract WebResultSettings getGridGraphSettings ()

Return a WebResultSettings object which can be used to control some of the EnumDSSXMLResult2Flags that will be used for all the RWGridGraphDef objects in the report writing document.

Returns

public abstract RWIncrementalFetchSettings getIncrementalFetchSettings ()

public abstract boolean getIsClientAuto ()

Get isClientAuto, which indicates whether the manipulation is client auto

Returns
  • isClientAuto

public abstract String getLastUpdate ()

Returns the time and date when this document was last updated against the warehouse.

Returns
  • A string representing the last updated time and date.

public abstract String getLogMessageAsXML ()

Returns log message for the current report. The parse method didn't provide here, if you want to parse the log message, please refer to com.microstrategy.MSTRTester.MSTRTesterModel#parseToMap(java.io.BufferedReader) and com.microstrategy.MSTRTester.MSTRTesterModel#parseToCSV(com.microstrategy.utils.json.JSONObject) for more detail

Returns
  • log message for the current report.
Throws
WebObjectsException indicates an inability to obtain the message information from the Intelligence Server.

public abstract String getMSTRPredictedFileSize (String documentID)

Get the predicted MSTR file size for a document or a report.

Returns
  • a json String e.g.{"mstr_size":0,"IsSetting":false}, the "mstr_size" is the predicted MSTR file size calculated by the i-Server. "IsSetting" indicates if the "mstr_size" is obtained by returning the value of 'MicroStrategy .(mstr) file size(MB)' set on the developer directly. If IsSetting is true meaning that the value of "mstr_size" was returned based on the value of 'MicroStrategy .(mstr) file size(MB)' set on developer; if IsSetting is false meaning that the value of "mstr_size" was calculated for a given document or report by the i-Server.
Throws
WebObjectsException

public abstract RWMessage getMessage ()

Returns A RWMessage object for the current RW doc.

Returns
Throws
WebObjectsException indicates an inability to obtain the message information from the Intelligence Server.

public abstract RWMessage getMessage (boolean populate)

Returns A RWMessage object for the current RW doc. If populate is true, the information is retreived from Intelligence Server.

Parameters
populate Whether the message should be populated with the inbox information for the message. This may cause an additional call to the Intelligence Server if it is set to true.
Returns
Throws
WebObjectsException indicates an inability to obtain the message information from the Intelligence Server.

public abstract Set<String> getNodesFilter ()

returns list of node keys those are set for the filter

public abstract byte[] getPDFData ()

Returns data for PDF export

Returns
  • byte[] PDS data
Throws
WebObjectsException
WebObjectsException

public abstract PersonalViewExecutionInfo getPersonalViewExecutionInfo ()

Get PersonalViewExecutionInfo, which indicates if personal manipulations all applied

Returns
  • PersonalViewExecutionInfo

public abstract WebPropertyGroup getProperties (String nodeKey)

returns the properties corresponding to a specific node

Parameters
nodeKey the key of the node
Returns
  • the properties
Throws
WebObjectsException

public abstract RWManipulation getRWManipulator (boolean validateStatus)

Returns RW manipulator

Parameters
validateStatus - boolean indicating whether we need to validate the ready status.
Returns
  • RW manipulator
Throws
WebObjectsException

public abstract RWManipulation getRWManipulator ()

Returns RW manipulator

Returns
  • RW manipulator
Throws
WebObjectsException
WebObjectsException
See Also
  • {@link #getRWManipulator(boolean)}

public abstract int getResultFilterMode ()

Returns the filter mode that is currently set. This is a value from the enumeration EnumRWResultFilterModes

public abstract RWSettings getResultSettings ()

public abstract String getResultsAsJson (int resultFlags)

Throws
WebObjectsException

public abstract String getResultsAsJson (int resultFlags, int mode)

THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.@return

Parameters
mode result data moda see EnumWebApiResultMode
Throws
WebObjectsException

public abstract String getResultsAsXML ()

Returns execution results as XML string

Returns
  • execution results as XML string
Throws
WebObjectsException

public abstract int getSaveAsDisplayMode ()

Returns the display mode for the saveAs call. These flags determine the format that the report is saved in. This value should be from EnumDSSXMLDisplayMode.

Returns
  • The current setting for display mode.
See Also

public abstract int getSaveAsFlags ()

Returns the flags for the saveAs call. These flags determine what is saved and the state it is saved in. This value should be the bitwise or (|) of values from EnumDSSXMLReportSaveAsFlags.

Returns
  • The current setting of the save as flags.
See Also

public abstract RWSecondaryDataProviderHelper getSecondaryDataProviderHelper ()

Returns a helper class for working with widget secondary data providers.

Returns
  • a helper class for working with widget secondary data providers.

public abstract boolean getSupportsUndo ()

Indicate that the application using this instance supports undo/redo

public abstract Set<String> getUpdatedUnits ()

public abstract WebVisualizationSettings getVisualizationSettings ()

This method exposes the visualization settings for the RW document.

Returns
Throws
WebObjectsException

public abstract String importImageToDocument (String treeType, String nodeKey, String fieldKey, String fieldName, String imgName, int index, long fileSize, String imgID, String hashCode, int isEdit, InputStream data)

Import image to document

Throws
WebObjectsException

public abstract String importImageToDocument (String binaryID, int blockCount, int blockIndex, int blockSize, String treeType, String nodeKey, String fieldKey, String fieldName, String imgName, int index, long fileSize, String imgID, String hashCode, int isEdit, InputStream data)

Import image to document

Throws
WebObjectsException

public abstract void includeFilterUnits ()

Include filter units in partial update result

public abstract boolean isDirty ()

Indicates whether the instance has been modified since it was first executed. This means that the version of the document in memory is different from the one saved in the metadata

Returns
  • boolean indicating if the document has been modified
See Also

public abstract boolean isMultiLayout ()

Returns true if this is a multi-layout document

Throws
WebObjectsException

public abstract void iterate (RWVisitor visitor, RWIterateSettings settings)

Iteration method for visiting the underlying object model. RWIterateSettings may be obtained from createIterateSettings().

Parameters
visitor the visitor
settings settings governing the behavior of the iteration
Throws
WebObjectsException if an error occurs during iteration

public abstract WebObjectInfo saveAs (WebFolder parentFolder, String name, String description)

Saves the current report instance, or template of the current report instance, or filter of the current report instance into the given folder with the given name and description. The saveAsFlags and saveAsDisplayMode control how the object is saved. One flag in saveAsFlags controls whether to save the report or template or filter of the current report. The new saved object returned without being populated.

Parameters
parentFolder The folder to place the new report in, an object of type WebFolder.
name The name of the new object to be saved.
description The description of the new object.
Returns
  • The WebObjectInfo object of saved object, it can be report or a filter or a template.
Throws
WebObjectsException Signals an error in sending the command to the Intelligence Server, receiving of an invalid DSS ID from the IServer corresponding to the saved object, or an invalid object name.

public abstract WebObjectInfo saveAs (WebFolder parentFolder)

Saves the current report instance, or template of the current report instance, or filter of the current report instance into the given folder with the given name and description. The saveAsFlags and saveAsDisplayMode control how the object is saved. One flag in saveAsFlags controls whether to save the report or template or filter of the current report. The new saved object returned without being populated.

Parameters
parentFolder The folder to place the new report in, an object of type WebFolder.
Returns
  • The WebObjectInfo object of saved object, it can be report or a filter or a template.
Throws
WebObjectsException Signals an error in sending the command to the Intelligence Server, or receiving of an invalid DSS ID from the IServer corresponding to the saved object.

public abstract WebObjectInfo saveAs (WebFolder parentFolder, String name)

Saves the current report instance, or template of the current report instance, or filter of the current report instance into the given folder with the given name and description. The saveAsFlags and saveAsDisplayMode control how the object is saved. One flag in saveAsFlags controls whether to save the report or template or filter of the current report. The new saved object returned without being populated.

Parameters
parentFolder The folder to place the new report in, an object of type WebFolder.
name The name of the new object to be saved.
Returns
  • The WebObjectInfo object of saved object, it can be report or a filter or a template.
Throws
WebObjectsException Signals an error in sending the command to the Intelligence Server, receiving of an invalid DSS ID from the IServer corresponding to the saved object, or an invalid object name.

public abstract String saveAsForManagedDataset (String folderID, String docName, String docDesc, boolean documentLevel, String reportSaveAsOptions)

Throws
MSTRWebAPIException
WebObjectsException

public abstract String saveAsForManagedDataset (String folderID, String docName, String docDesc, boolean documentLevel, String reportSaveAsOptions, IntWrapper status, int requestTimeout)

Saves managed dataset or standalone dataset within the current report instance. The saveAsFlags is set to 16 to indicate this is a dataset level saveas, or other value depending on user input to enter document level saveas. The status is returned.

Parameters
folderID The id of the folder to place the document. When dataset level saveas, it doesn't matter.
docName The name of the new document to be saved.
docDesc The description of the new document.
documentLevel Whether this is a document level saveas
reportSaveAsOptions The xml delta of the report SaveAs options for datasets within document.
status Contains the current status of the document.
requestTimeout the amount to wait in milliseconds for the xml command
Returns
  • objectID
Throws
WebObjectsException Signals an error in sending the command to the Intelligence Server, receiving of an invalid DSS ID from the IServer corresponding to the saved object, or an invalid object name.
MSTRWebAPIException Signals duplicated name error or other errors.

public abstract String saveAsSegment (WebFolder parentFolder, String name, String description, int flags, String nodeKey)

Save segment from RWD.

Parameters
parentFolder The folder to place the new segment in, an object of type WebFolder.
name A name for the segment.
description A description for the segment.
flags Flags which modify the behavior of the call.
nodeKey the key to locate the node
Returns
  • the new created segment's id
Throws
WebObjectsException

public abstract String saveAsTheme (String folderID, String themeName, String themeDesc, int flags)

Save the document theme as a standalone object.

Parameters
folderID The id of the folder to place the theme.
themeName The name of the new document theme to be saved.
themeDesc The description of the new document theme.
flags Flags which modify the behavior of the call, from EnumDSSXMLDocSaveAsFlags.
Returns
  • objectID the id of the new document theme.
Throws
WebObjectsException
MSTRWebAPIException
WebObjectsException

public abstract String saveDerivedElements (String unitKey, String attId, String folderId, String name, String description, boolean overwrite)

Throws
WebObjectsException
WebReportValidationException

public abstract void sendExportData (IContentConsumer contentConsumer)

Streams binary export data received from IServe to a content consumer. This method is used to avoid buffering export data inside web server.

Parameters
contentConsumer a consumer of export data.
Throws
WebObjectsException
WebObjectsException

public abstract void setControlFilter (Set<String> units)

Sets control filter

Parameters
units a list of control keys that updated by user

public abstract void setCurrentLayoutKey (String value)

Switches to a new current layout.

Parameters
value the key of a layout that must be set current.

public abstract void setDocumentProperty (String propertySetName, String propertyName, String propertyValue)

Sets document's property

Parameters
propertySetName property set name
propertyName property name
propertyValue value
Throws
WebObjectsException

public abstract void setExecutionMode (int mode)

Sets execution mode

Parameters
mode exectuon mode from EnumRWExecutionModes

public abstract void setExportCacheID (byte[] exportCacheID)

set the exportCacheID of the instance

Parameters
exportCacheID the cacheID of the instance

public abstract void setGridIncrementalFetch (String unitKey, int rowMode, int rowPosition, int maxRows, int colMode, int colPosition, int maxColumns)

Sets grid incremental fetch position

Parameters
unitKey the grid unit key
rowMode row incremental fetch mode
rowPosition rows position
maxRows maximum number of rows per page
colMode column incremental fetch mode
colPosition columns position
maxColumns maximum number of columns per page

public abstract void setGridIncrementalFetch (String unitKey, int rowPosition, int maxRows, int colPosition, int maxColumns)

Sets grid incremental fetch position

Parameters
unitKey the grid unit key
rowPosition rows position
maxRows maximum number of rows per page
colPosition columns position
maxColumns maximum number of columns per page

public abstract void setIsClientAuto (boolean isClientAuto)

Set isClientAuto, which indicates whether the manipulation is client auto

public abstract void setNodesFilter (Set<String> units)

Sets nodes filter

Parameters
units a list of node keys that updated by user

public abstract void setPersonalViewExecutionInfo (PersonalViewExecutionInfo pvInfo)

Set PersonalViewExecutionInfo, which indicates if personal manipulations all applied

public abstract void setProperty (String unitKey, String propertySetName, String propertyName, String propertyValue)

Sets a property value for the specified unit

Parameters
unitKey unit key
propertySetName property set name
propertyName property name
propertyValue value
Throws
WebObjectsException

public abstract void setResultFilterMode (int resultFilterMode)

Sets the filter mode. The value to be set is one defined in EnumRWResultFilterModes If one is not specified, the default used would be RW_RESULT_FILTER_DEFAULT

public abstract void setSaveAsDisplayMode (int saveAsDisplayMode)

Sets the display mode for the saveAs call. These flags determine the format that the report is saved in. This value should be from EnumDSSXMLDisplayMode.

Parameters
saveAsDisplayMode The value to use as the save as display mode.
See Also

public abstract void setSaveAsFlags (int saveAsFlags)

Sets the flags for the saveAs call. These flags determine what is saved and the state it is saved in. This value should be the bitwise or (|) of values from EnumDSSXMLReportSaveAsFlags.

Parameters
saveAsFlags The value to use as the save as flags.
See Also

public abstract void setStateID (int stateID)

set the steateID of inboxMessage of instance

Parameters
stateID the steateID of inboxMessage of instance

public abstract void setSupportsUndo (boolean value)

Sets flag indication that application using this instance supports undo/redo

public abstract void setUnitsFilter (Set units)

Sets units filter

Parameters
units a list of unit keys that will be returned from the server

public abstract void setUnitsFilterProps (Map defnFilterProps, Map dataFilterProps)

Sets the JSON properties in the units filter for the server to return.

public abstract void setUpdatedObjectsFilter (Set<MojoRWUpdatedObjectsSettings> objects)

Set the partial update on object keys. Added for html5 vi.

Parameters
objects a list of updated object keys.

public abstract void setUpdatedUnitsFilter (Set<String> nodes)

Sets update units filter

Parameters
nodes a list of node keys that updated by user

public abstract void subscribe (WebSubscriptionTrigger trigger, WebSubscriptionAddress address, String subject, boolean sendNow, String customMessage, WebSubscriptionContentFormat format, boolean zip)

Subscibes a user to this document

Parameters
trigger subscription trigger
address subscription address
subject subject string
sendNow flag indicating that a message shall be send immediately
customMessage custom message string
format subscription format
zip flag indication that content must be compressed
Throws
WebObjectsException