public interface

WebReportInstance

implements WebResultSetInstance WebViewInstance
com.microstrategy.web.objects.WebReportInstance

Class Overview

The WebReportInstance interface represents an instance of a report. A report instance is identified by its message ID and state. This interface can be used to retrieve the results of a report, to access its template (encapsulated by WebViewInstance), filter, or working set, or to obtain several of the other objects which allow report manipulation. The WebReportInstance can be obtained from the WebReportSource interface or from a method which performs any type of report manipulation.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void clearDatamartInfo()
clears the datamart info.
abstract WebSubscription createNewSubscription(int deliveryMode)
Creates a new WebSubscription object which can then be used to define relevant subscription properties and can be saved in order to create a new Narrowcast subscription.
abstract WebReportInstance directSave(int saveAsDisplayMode)
Direct save the current report instance.
abstract WebReportInstance directSave(int saveAsDisplayMode, String desc, int saveFlags)
Direct save the current report instance.
abstract WebReportInstance directSave(int saveAsDisplayMode, String desc)
Direct save the current report instance.
abstract byte[] getBinaryData()
Returns binary data for this instance in the format specified by the execution mode (see setExecutionMode(int)).
abstract String getCSVData()
This method is deprecated. replace by WebReportPlainTextExportSettings
abstract String getCubeName()
abstract int getDESourceMode(WebAttribute attr)
abstract WebDatamart getDatamartInfo(boolean convertIfNot)
Retrieves the datamart information as WebDatamart.
abstract int getDefaultExpansionLevel(WebAttribute attribute)
Returns the default expansion level for the specified Recursive Attribute.
abstract byte[] getExcelBinaryData()
Returns the binary data corresponding to REPORT_MODE_EXCEL.
abstract String getExcelData()
This method is deprecated. for REPORT_MODE_PLAIN_TEXT use getPlainTextData(), for REPORT_MODE_EXCEL use getExcelBinaryData()
abstract int getExecutionMode()
Returns the specified execution mode.
abstract WebReportExportSettings getExportSettings()
Returns export settings object that corresponds to the current execution mode (getExecutionMode()).
abstract WebFilter getFilter(boolean populate)
This method is deprecated. getFilter() should suffice all use cases for getting filter. Note that getFilter() always ensures that a populated filter is returned. The filter population is currently asynchronous. In future release, the filter population would be tied to a report instance property e.g. setAsync(boolean)
abstract WebFilter getFilter()
Returns the current state of the view filter object, according to the Intelligence Server.
abstract WebGraphLabels getGraphLabels(int labelType)
Returns the collection WebGraphLabels that represents the list of labels in either the series or categories axis available for the particular graph
abstract WebGraph getGraphObject()
Returns a WebGraph object, which allows a user to manipulate and load a graph data stream.
abstract WebGridWidths getGridWidths()
Returns a WebGridWidths object, which can be used to manipulate the column width settings of the report.
abstract WebMDXCube getMDXCube()
Returns the MDX cube object that is the source for the report, if the report is an MDX report.
abstract WebReportMessage getMessage(boolean populate)
Returns A WebReportMessage object for the current report.
abstract WebReportMessage getMessage()
Returns A WebReportMessage object for the current report.
abstract byte[] getPDFData()
Returns the data corresponding to this instance in pdf format.
abstract String getPlainTextData()
Returns the text data corresponding to this instance.
abstract WebPropertySet getPropertySet(int reportObjectType, String propertySetName)
Returns the WebPropertySet for the given report object type.
abstract SimpleList getPropertySetFilter(int reportObjectType)
This method modifies the set of report property sets returned from the getPropertySets call.
abstract WebPropertyGroup getPropertySets(int reportObjectType)
Returns the WebPropertyGroup for the given report object type.
abstract WebReportManipulation getReportManipulator(boolean validateStatus)
This is convenience method which fetches the manipulator by optionally avoiding the ready status check.
abstract WebReportManipulation getReportManipulator()
Returns a WebReportManipulation object, which allow the setting of options and submission of a report manipulation operation.
abstract int getResultFlags()
Returns the current result flags setting, which determines the information which the Intelligence Server will return in its report XML.
abstract WebResultSettings getResultSettings()
Returns an object of WebResultSettings type, which can be used to define settings which affect the results returned from the Intelligence Server.
abstract WebResultWindow getResultWindow()
Returns a WebResultWindow object, which can be used to modify the report window being returned from the Intelligence Server.
abstract WebReportData getResults()
Attempts to obtain the report results from the Intelligence Server, and load those results into a WebReportData object.
abstract String getResultsAsJSON()
Attempts to obtain the report results from the Intelligence Server, and return those results in JSON format.
abstract String getResultsAsXML()
Attempts to obtain the report results from the Intelligence Server, and return those results in XML format.
abstract int getSaveAsDisplayMode()
Returns the display mode for the saveAs call.
abstract int getSaveAsFlags()
Returns the flags for the saveAs call.
abstract int getSaveStateID()
Returns the current save state ID set on the report instance.
abstract WebTable getSourceTable()
Returns the source table for the report, if the report comes from an XDA source.
abstract WebTemplate getTemplate(boolean populate)
This method is deprecated. getTemplate() should suffice all use cases for getting template. Note that getTemplate() always ensures that a populated template is returned. The template population is currently asynchronous. In future release, the template population would be tied to a report instance property e.g. setAsync(boolean)
abstract WebExpression getUnitLimit(WebObjectInfo object)
Returns unit limit associated with the specified report object
abstract WebVisualizationSettings getVisualizationSettings()
Returns a WebVisualizationSettings object, that can be used to set the visualization settings of the report instance.
abstract WebWorkingSet getWorkingSet()
Returns a WebWorkingSet object, which can be used to get the working set objects, the base filter of a report instance, or perform other operations relating to the working set of the report.
abstract int getXdaType()
abstract boolean isDatamart()
Indicates whether the report that this instance corresponds to is a datamart report.
abstract boolean isDrilled()
Indicates whether the report that this instance corresponds to is a drilled report.
abstract boolean isExpansionLevelInhereted(WebAttribute attribute)
Returns true if the default expansion level was inhereted from the attribute definition
abstract boolean isPrompted(boolean includeDormant)
Returns whether the report is prompted or not.
abstract boolean isRepromptable()
abstract boolean isSerializeReportData()
This flag indicates whether the report XML of the actual report data will be saved when serializing.
abstract String pollStatusOnly(String extParams)
Checks the status (see EnumDSSXMLStatus) with extendable parameters@return
abstract void removeUnitLimit(String unitId)
Removes unit limit for the specified report object
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 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 String saveDerivedElements(String attId, String folderId, String name, String description, boolean overwrite)
abstract void sendExportData(IContentConsumer streamingContext)
abstract void setDefaultExpansionLevel(WebAttribute attribute, int value)
Sets the default expansion level for the specified Recursive Attribute.
abstract void setDefaultForProperty(int reportObjectType, String propertySetName, String propertyName)
Sets the current value for the given property to be its default value.
abstract void setExecutionMode(int mode)
Sets the right execution mode.
abstract void setProperty(int reportObjectType, String propertySetName, String propertyName, String value)
Sets the given property on the given report object to the given value.
abstract void setResultFlags(int resultFlags)
Sets the current result flags setting, which determines the information which the Intelligence Server will return in its report XML.
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 setSerializeReportData(boolean serialize)
Sets the "Serialize Report Data" flag.
abstract void setUnitLimit(WebObjectInfo object, WebExpression expr)
Sets unit limit for the specified report object
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebResultSetInstance
From interface com.microstrategy.web.objects.WebViewInstance

Public Methods

public abstract void clearDatamartInfo ()

clears the datamart info. This is equivalent to unsetting the datamart.

public abstract WebSubscription createNewSubscription (int deliveryMode)

Creates a new WebSubscription object which can then be used to define relevant subscription properties and can be saved in order to create a new Narrowcast subscription.

Parameters
deliveryMode EnumWebSubscriptionDeliveryMode
Returns
  • the new subscription
Throws
WebObjectsException

public abstract WebReportInstance directSave (int saveAsDisplayMode)

Direct save the current report instance.

Parameters
saveAsDisplayMode The value to use as the save as display mode.
Returns
  • The new report instance.
Throws
WebObjectsException

public abstract WebReportInstance directSave (int saveAsDisplayMode, String desc, int saveFlags)

Direct save the current report instance.

Parameters
saveAsDisplayMode The value to use as the save as display mode.
desc The description of the report
saveFlags current options of what flags are set to save the report
Returns
  • The new report instance.
Throws
WebObjectsException

public abstract WebReportInstance directSave (int saveAsDisplayMode, String desc)

Direct save the current report instance.

Parameters
saveAsDisplayMode The value to use as the save as display mode.
desc The description of the report
Returns
  • The new report instance.
Throws
WebObjectsException

public abstract byte[] getBinaryData ()

Returns binary data for this instance in the format specified by the execution mode (see setExecutionMode(int)).

NOTE: Currently, if the execution mode is REPORT_MODE_PLAIN_TEXT, exporting less than the whole report is not supported (see getMode()). In this case, an IllegalStateException will be thrown. Use getPlainTextData() for this case.

Returns
  • Binary data (PDF, Excel binary, plain text, etc.) for the report instance.
Throws
IllegalStateException If the current mode (as indicated by getMode()) is to display less than the whole report, or the execution mode (see setExecutionMode(int)) is not set correctly for exporting.
WebObjectsException
WebObjectsException

public abstract String getCSVData ()

This method is deprecated.
replace by WebReportPlainTextExportSettings

Returns the data corresponding to this instance as comma separated values This corresponds to REPORT_MODE_CSV

Returns
  • the text data corresponding to this instance
Throws
WebObjectsException
WebObjectsException
See Also

public abstract String getCubeName ()

public abstract int getDESourceMode (WebAttribute attr)

Throws
WebObjectsException

public abstract WebDatamart getDatamartInfo (boolean convertIfNot)

Retrieves the datamart information as WebDatamart.

Parameters
convertIfNot indicates whether the current instance should be converted into a datamart report if it is not one already. The method returns null if this is a datamart instance and the boolean parameter is false
Throws
WebObjectsException

public abstract int getDefaultExpansionLevel (WebAttribute attribute)

Returns the default expansion level for the specified Recursive Attribute.

Parameters
attribute A recursive attribute within this report

public abstract byte[] getExcelBinaryData ()

Returns the binary data corresponding to REPORT_MODE_EXCEL.

Returns
  • formatted excel data
Throws
WebObjectsException
WebObjectsException
See Also

public abstract String getExcelData ()

This method is deprecated.
for REPORT_MODE_PLAIN_TEXT use getPlainTextData(), for REPORT_MODE_EXCEL use getExcelBinaryData()

Returns the data corresponding to REPORT_MODE_PLAIN_TEXT.

NOTE: this has changed from 8.0.0 - it used to be associated with REPORT_MODE_EXCEL.

Returns
  • the excel data corresponding to this instance
Throws
WebObjectsException
WebObjectsException

public abstract int getExecutionMode ()

Returns the specified execution mode. If one is not explicitly set, the default value is REPORT_MODE_DEFAULT

Returns
  • the specified execution mode

public abstract WebReportExportSettings getExportSettings ()

Returns export settings object that corresponds to the current execution mode (getExecutionMode()). This object can be used to customize the export output.
The following describes the execution mode associations, and the export settings subclass, which WebReportExportSettings may be cast into:


It can be used as follows:

getReportBean().setExecutionMode(EnumWebReportExecutionModes.REPORT_MODE_PLAIN_TEXT);
WebReportPlainTextExportSettings exportSettings = (WebReportPlainTextExportSettings) getReportBean().getReportInstance().getExportSettings();
exportSettings.setSeparator("|");
byte[] data = getReportBean().getReportInstance().getBinaryData();
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 WebFilter getFilter (boolean populate)

This method is deprecated.
getFilter() should suffice all use cases for getting filter. Note that getFilter() always ensures that a populated filter is returned. The filter population is currently asynchronous. In future release, the filter population would be tied to a report instance property e.g. setAsync(boolean)

Returns a WebFilter object, which can be used to modify the report's view filter. The populate argument will tell whether or not the returned WebFilter should be populated with XML from the Intelligence server. If populate is false, then an empty WebFilter object should be returned instead.

Parameters
populate True if the returned filter should be populated, false if it should not be populated before returning.
Returns
  • A WebFilter object, which can be used to modify the view filter.
Throws
WebObjectsException Signals an error occurred while obtaining the view filter XML from the Intelligence Server.

public abstract WebFilter getFilter ()

Returns the current state of the view filter object, according to the Intelligence Server.

Returns
  • A WebFilter object, which represents the current state of the view filter. This can be used to modify the view filter.
Throws
WebObjectsException Signals an error occurred while obtaining the view filter XML from the Intelligence Server.

public abstract WebGraphLabels getGraphLabels (int labelType)

Returns the collection WebGraphLabels that represents the list of labels in either the series or categories axis available for the particular graph

Parameters
labelType from EnumWebGraphLabelType

public abstract WebGraph getGraphObject ()

Returns a WebGraph object, which allows a user to manipulate and load a graph data stream. This object would normally be used in a interface page or component that outputs a binary stream representing the graph image.Given the session ID, message ID and state ID of the report to be graphed. Other properties may be changed to manipulate the style of that graph produced.

Returns
  • A WebGraph object for this report instance.
Throws
WebObjectsException Thrown if the report is not determined to be in the correct state.

public abstract WebGridWidths getGridWidths ()

Returns a WebGridWidths object, which can be used to manipulate the column width settings of the report.

Returns
Throws
WebObjectsException Thrown when this report instance is not in ready state.

public abstract WebMDXCube getMDXCube ()

Returns the MDX cube object that is the source for the report, if the report is an MDX report.

Returns
  • A WebMDXCube object that can be used to browse the cube contents.
Throws
WebObjectsException

public abstract WebReportMessage getMessage (boolean populate)

Returns A WebReportMessage object for the current report. 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 WebReportMessage getMessage ()

Returns A WebReportMessage object for the current report.

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

public abstract byte[] getPDFData ()

Returns the data corresponding to this instance in pdf format.

Throws
WebObjectsException
See Also

public abstract String getPlainTextData ()

Returns the text data corresponding to this instance. By default, they will be comma delimited, but may be customized via ((WebReportPlainTextExportSettings) WebReportPlainTextExportSettings).

Returns
  • text data corresponding to this instance
Throws
WebObjectsException
WebObjectsException

public abstract WebPropertySet getPropertySet (int reportObjectType, String propertySetName)

Returns the WebPropertySet for the given report object type. If this property set has not yet been retrieved from the Intelligence Server, then this method will trigger a call to the Intelligence Server to retrieve it.

Parameters
reportObjectType The report object whose properties are to be retrieved, from EnumDSSXMLReportObjects.
Returns
  • The property set associated with the report object and the name provided.
Throws
WebObjectsException Thrown if an error occurs in asking the Intelligence
IllegalArgumentException Thrown if the propertySetName provided is not valid Server for properties.

public abstract SimpleList getPropertySetFilter (int reportObjectType)

This method modifies the set of report property sets returned from the getPropertySets call. This method returns a SimpleList object which can be used to filter the property sets returned from the getPropertySets call. The way the property sets work is that there is one property set for each value in EnumDSSXMLReportObjects. Each report object type has a SimpleList of Strings as it's filter - if this list is empty, then all properties will be retrieved for this property set. However, if there are one or more property set names in the filter, then only those property sets will be retrieved from the backend when calling getPropertySets with the same object type.

Parameters
reportObjectType The report object to retrieve the property set filter for; this should be a value from EnumDSSXMLReportObjects.
Returns
  • A SimpleList object, which contains Strings corresponding to the property sets to retrieve.

public abstract WebPropertyGroup getPropertySets (int reportObjectType)

Returns the WebPropertyGroup for the given report object type. If the property sets have not yet been retrieved from the Intelligence Server, then this method will trigger a call to the Intelligence Server to retrieve those property sets.

If the property set filter associated with the given report object type is set, then the property set returned will be constrained to only have those property sets in the filter.

Parameters
reportObjectType The report object whose properties are to be retrieved, from EnumDSSXMLReportObjects.
Returns
  • The property sets associated with the report object.
Throws
WebObjectsException Thrown if an error occurs in asking the Intelligence Server for properties.

public abstract WebReportManipulation getReportManipulator (boolean validateStatus)

This is convenience method which fetches the manipulator by optionally avoiding the ready status check. @return

Throws
WebObjectsException
WebObjectsException
See Also
  • {@link #getReportManipulator()}

public abstract WebReportManipulation getReportManipulator ()

Returns a WebReportManipulation object, which allow the setting of options and submission of a report manipulation operation. The check to ensure ready status is currently asynchronous. In future release, it would be tied to a report instance property e.g. setAsync(boolean)

Returns
  • A WebReportManipulation object, which can be used to make manipulations to the current report instance. The default execution flag in this object will be EnumDSSXMLExecutionFlags.DssXmlExecutionUseCache | EnumDSSXMLExecutionFlags.DssXmlExecutionUpdateCache, and the default result flags will be EnumDSSXMLResultFlags.DssXmlResultPreserve | EnumDSSXMLResultFlags.DssXmlResultNoDerivedPromptXML.
Throws
WebObjectsException Thrown if the report is not determined to be in the correct state.

public abstract int getResultFlags ()

Returns the current result flags setting, which determines the information which the Intelligence Server will return in its report XML.

Returns
  • The current result flags setting; this value should be the bitwise or (|) of values from EnumDSSXMLResultFlags.
See Also

public abstract WebResultSettings getResultSettings ()

Returns an object of WebResultSettings type, which can be used to define settings which affect the results returned from the Intelligence Server.

Returns
See Also

public abstract WebResultWindow getResultWindow ()

Returns a WebResultWindow object, which can be used to modify the report window being returned from the Intelligence Server.

Returns
  • A WebResultWindow object, which can be used to modify several window-related settings. A reference to this object will be kept internally, and when necessary, the WebReportInstance object will query the WebResultWindow object in order to obtain the user's settings.

public abstract WebReportData getResults ()

Attempts to obtain the report results from the Intelligence Server, and load those results into a WebReportData object. For a page-by report, only the current page is returned. To retrieve another page, you need to call setCurrentElement(String) or setCurrentElement(String, int) to switch to another page. After that, you need to obtain the results again.

Returns
Throws
WebObjectsException Thrown if the method has difficulty in contacting the Intelligence Server.

public abstract String getResultsAsJSON ()

Attempts to obtain the report results from the Intelligence Server, and return those results in JSON format.

Returns
  • The resulting report JSON, or an empty string if it is not yet ready.
Throws
WebObjectsException Thrown if the method has difficulty in contacting the Intelligence Server.

public abstract String getResultsAsXML ()

Attempts to obtain the report results from the Intelligence Server, and return those results in XML format. For a page-by report, only the current page is returned. To retrieve another page, you need to call setCurrentElement(String) or setCurrentElement(String, int) to switch to another page. After that, you need to obtain the results again.

Returns
  • The resultant report XML, or an empty string if it is not yet ready.
Throws
WebObjectsException Thrown if the method has difficulty in contacting the Intelligence Server.

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 int getSaveStateID ()

Returns the current save state ID set on the report instance.

Returns
  • The save state ID of the report instance.

public abstract WebTable getSourceTable ()

Returns the source table for the report, if the report comes from an XDA source. Returns null for a report whose source is the warehouse (i.e. a non-XDA report). The returned table can be queried for it's XDA type.

Returns
  • A WebTable object which describes the source for an XDA-based report, null if the report came from the warehouse.
Throws
WebObjectsException Thrown if an error occurs.

public abstract WebTemplate getTemplate (boolean populate)

This method is deprecated.
getTemplate() should suffice all use cases for getting template. Note that getTemplate() always ensures that a populated template is returned. The template population is currently asynchronous. In future release, the template population would be tied to a report instance property e.g. setAsync(boolean)

Returns a WebTemplate object, referring to the template contained on this report. If populate is true, then the template will be populated with the current definition of the template according to the Intelligence Server. If it is false, then an empty template will be returned, and it must be populated from an existing template XML. This functionality is primarily used to avoid returning to the server to reload template XML for every web page.

Parameters
populate If this is true, then the template will be obtained from the Intelligence Server.
Returns
  • A WebTemplate object which contains the template information for this report instance.
Throws
WebObjectsException Indicates an inability to obtain the template definition from the Intelligence Server.

public abstract WebExpression getUnitLimit (WebObjectInfo object)

Returns unit limit associated with the specified report object

public abstract WebVisualizationSettings getVisualizationSettings ()

Returns a WebVisualizationSettings object, that can be used to set the visualization settings of the report instance.

Returns
Throws
WebObjectsException

public abstract WebWorkingSet getWorkingSet ()

Returns a WebWorkingSet object, which can be used to get the working set objects, the base filter of a report instance, or perform other operations relating to the working set of the report. The working set population from IServer is currently asynchronous. In future release, it would be tied to a report instance property e.g. setAsync(boolean)

Returns
  • A WebWorkingSet object which gives access to working set functionality.
Throws
WebObjectsException Thrown if the working set XML is not cached in the report instance, and an error occurs when retrieving it from the Intelligence Server.

public abstract int getXdaType ()

Throws
WebObjectsException

public abstract boolean isDatamart ()

Indicates whether the report that this instance corresponds to is a datamart report.

Throws
WebObjectsException

public abstract boolean isDrilled ()

Indicates whether the report that this instance corresponds to is a drilled report. This is only supported against server versions higher than 8.0.2.

public abstract boolean isExpansionLevelInhereted (WebAttribute attribute)

Returns true if the default expansion level was inhereted from the attribute definition

public abstract boolean isPrompted (boolean includeDormant)

Returns whether the report is prompted or not. The includeDormant parameter will determine whether dormant prompts should be considered in the result.

Parameters
includeDormant True if the presence of a dormant prompt should cause this method to return true, false if this method should only consider the report prompted if it contains used prompts.
Returns
  • Whether the report is prompted.
Throws
WebObjectsException Throws if an I-Server error occurs or the report is in an unexpected status.

public abstract boolean isRepromptable ()

public abstract boolean isSerializeReportData ()

This flag indicates whether the report XML of the actual report data will be saved when serializing.

Returns
  • The current value for the "serialize report data" flag.

public abstract String pollStatusOnly (String extParams)

Checks the status (see EnumDSSXMLStatus) with extendable parameters@return

Throws
WebObjectsException

public abstract void removeUnitLimit (String unitId)

Removes unit limit for the specified report object

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 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 String saveDerivedElements (String attId, String folderId, String name, String description, boolean overwrite)

Throws
WebObjectsException
WebReportValidationException

public abstract void sendExportData (IContentConsumer streamingContext)

Throws
WebObjectsException

public abstract void setDefaultExpansionLevel (WebAttribute attribute, int value)

Sets the default expansion level for the specified Recursive Attribute. If there is no any limit expression specified for this attribute, then report will contain elements up to specified level.

Parameters
attribute A recursive attribute within this report
value An expansion level - a positive integer starting with 1 or one of the special values:
  • -1 means that all levels shall be present
  • -2 means that the setting from the attribute definition will be used

public abstract void setDefaultForProperty (int reportObjectType, String propertySetName, String propertyName)

Sets the current value for the given property to be its default value.

Parameters
reportObjectType The report object which contains the property to change, from EnumDSSXMLReportObjects.
propertySetName The name of the property set which contains the property to change.
propertyName The name of the property to change.
Throws
IllegalArgumentException Thrown if a parameter passed to this method does not make sense.
WebObjectsException Thrown if an error occurs when setting the property value.

public abstract void setExecutionMode (int mode)

Sets the right execution mode. An execution mode indicates what the intended usage of this bean is. This allows for executing the underlying report with the right set of execution flags

Parameters
mode a value from the enumeration EnumWebReportExecutionModes

public abstract void setProperty (int reportObjectType, String propertySetName, String propertyName, String value)

Sets the given property on the given report object to the given value.

Parameters
reportObjectType The report object which contains the property to change, from EnumDSSXMLReportObjects.
propertySetName The name of the property set which contains the property to change.
propertyName The name of the property to change.
value The value to which the property should be set.
Throws
IllegalArgumentException Thrown if a parameter passed to this method does not make sense.
WebObjectsException Thrown if an error occurs when setting the property value.

public abstract void setResultFlags (int resultFlags)

Sets the current result flags setting, which determines the information which the Intelligence Server will return in its report XML.

Parameters
resultFlags The desired result flags setting; this value should be the bitwise or (|) of values from EnumDSSXMLResultFlags.
See Also

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 setSerializeReportData (boolean serialize)

Sets the "Serialize Report Data" flag. This flag indicates whether the report XML of the actual report data will be saved when serializing. The default is false.

Parameters
serialize Whether the flag should be true or false.

public abstract void setUnitLimit (WebObjectInfo object, WebExpression expr)

Sets unit limit for the specified report object