public interface

WebReportData

implements WebGraph WebGridData
com.microstrategy.web.objects.WebReportData

Class Overview

The WebReportData interface represents the data of a report. This class exposes many different pieces of miscellaneous data in the report. Note that some of the methods on the interface rely upon certain result flags to be set when obtaining the XML, and if the correct flags are not set, those methods will return default values.

Summary

Public Methods
abstract String getBaseFilterDetails()
This method is deprecated. use a transform (e.g. com.microstrategy.web.app.transforms.ExpressionPlainTextTransform) to display the working set filter expression
abstract String getBaseFilterName()
Returns the name of the base filter within the current report.
abstract WebCSSHelper getCSSHelper()
Returns the WebCSSHelper object, which can be used to translate the format properties into css string.
abstract String getDatamartTableName()
Returns the datamart table name used in this report.
abstract int getDrillOptions()
Allows a user to extract the value of the Drilling Options.
abstract boolean getEnableReportDrilling()
Returns whether or not the drill option is enabled.
abstract String getErrorInGraph()
Returns an error number returned when attempting to execute a graph.
abstract String getFilterDetails()
abstract String getFilterExpressionDescriptor()
abstract String getFilterExpressionDetails()
abstract String getFilterExpressionViewDescriptor()
abstract WebFolder getFolder()
Returns the parent folder of this report as a WebFolder object.
abstract String getFolderID()
Returns the ID of the parent folder of this report.
abstract String getFolderName()
Returns the name of the parent folder of this report.
abstract WebGraphProperties getGraphProperties()
Returns the graph properties for the report.
abstract int getGraphTotalColumns()
Returns the total number of columns in this graph report.
abstract int getGraphTotalRows()
Returns the total number of rows in this graph report.
abstract int getGraphTypesAvailable()
Returns the available graph types for this particular report.
abstract String getGridStyle()
Returns the grid style of the current report.
abstract int getGridTotalColumnBlocks()
abstract int getGridTotalColumns()
Returns the total number of columns in this grid report.
abstract int getGridTotalRowBlocks()
abstract int getGridTotalRows()
Returns the total number of rows in this grid report.
abstract String getJobID()
Returns the job ID when this report gets executed in the Intelligence Server.
abstract String getLastUpdate()
Returns the time and date when this report was last updated against the warehouse.
abstract String getMetricConditionality(String dssid)
Returns a string representing the conditionality of a metric on the report.
abstract String getMetricFormula(String dssid)
Returns a string representing the formula of a metric on the report.
abstract String getMetricsLimit()
Returns the limit information set on the metrics of the report.
abstract String getOriginalReportID()
Returns the ID of the original report after report manipulation may have occurred.
abstract String getPromptDetails()
abstract String getReportDescription()
Returns report description of the current report instance.
abstract String getReportDetails()
abstract String getReportFilterName()
Returns the name of the report filter.
abstract String getReportID()
Returns report ID of the current report instance.
abstract String getReportName()
Returns report name of the current report instance.
abstract String getReportPath()
Returns the folder path to the current report.
abstract WebProperties getReportProperties()
Returns the report properties.
abstract String getReportTemplateName()
Returns the name of the report template.
abstract String getReportType()
This method is deprecated. this now maps to getRequestType()
abstract int getRequestType()
Returns the type of the type of the current report.
abstract WebResultWindow getResultWindow()
Gets the WebResultWindow object, which contains information about the report result window.
abstract String getSQL()
Returns the SQL for the current report.
abstract String getTemplateDetails()
abstract String getTemplateLimit()
This method is deprecated. Please use getMetricsLimit instead. Required result flag to use this method is DssXmlResultDtlsTemplateLimit.
abstract String getTemplateLimitDescriptor()
abstract String getTemplateLimitViewDescriptor()
abstract String getTemplateName()
Returns the template name for the current report.
abstract WebFolder getTemplateObjects()
Returns a WebFolder object containing information about all objects found on the template (metrics, attributes, etc).
abstract String getTemplateUnitsLimit()
This method returns the summary of the limit information set on the individual units of the base template.
abstract int getType()
Returns the type of the type of the current report.
abstract String getViewFilterDetails()
This method is deprecated. Not used
abstract String getViewMode()
Returns the view mode for the current report.
abstract String getViewTemplateLimit()
Returns the template metric limit for the view report.
abstract WebReportGrid getWebReportGrid()
Returns the report grid.
abstract String getXML()
Returns the report result XML.
abstract boolean hasMetrics()
Returns whether the report contains any metrics.
abstract boolean isChartAvailable()
Returns whether or not a chart is available for this report.
abstract boolean isDrillKeepParent()
Returns whether or not the user has specified to keep parent attribute while drilling.
abstract boolean isDrilledReport()
Returns whether or not this report is the result of a drill operation.
abstract boolean isPromptedReport(boolean includeDormant)
Returns whether or not this report is the result of a prompt operation.
abstract boolean isPromptedReport()
Returns whether or not this report is the result of a prompt operation.
abstract boolean isReportFilterLinked()
Returns true if the report filter is linked.
abstract boolean isReportTemplateLinked()
Returns true if the report template is linked.
abstract boolean isReportTruncated()
Returns whether or not this report is truncated.
abstract boolean isShowBanding()
Returns whether the report is currently shown in banding mode.
abstract boolean isTotalAvailable()
Returns whether or not totals are available for this report.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebGraph
From interface com.microstrategy.web.objects.WebGridData

Public Methods

public abstract String getBaseFilterDetails ()

This method is deprecated.
use a transform (e.g. com.microstrategy.web.app.transforms.ExpressionPlainTextTransform) to display the working set filter expression

Returns the filter details for the base report.

Returned from XSL pattern search: "/mi/rit/working_set/f/mi/exp[position()=1]/text()".

Required result flag to use this method is DssXmlResultWorkingSet.

Deprecated. Use com.microstrategy.web.app.transforms.ExpressionPlainTextTransform to display.

 ...
 ReportBean rb;
 MarkupOutput mo;
 ...
 ExpressionObject expObj;
 
 expObj = WebBeanFactory.getInstance().newExpressionObject(rb.getReportInstance().getWorkingSet().getFilter().getExpression(), rb.getBeanContext(), rb.getReportInstance().getWorkingSet());
 ExpressionPlainTextTransform expressionTransform = new ExpressionPlainTextTransform();
 expressionTransform.transform(expObj, markupOutput);

Returns
  • A string value of the filter details for the base report.

public abstract String getBaseFilterName ()

Returns the name of the base filter within the current report.

Returned from XSL pattern search: "/mi/rit/working_set/f/mi/in/oi[@tp=\"1\"]/@n"

Required result flag to use this method is DssXmlResultWorkingSet.

Returns
  • The base filter name.

public abstract WebCSSHelper getCSSHelper ()

Returns the WebCSSHelper object, which can be used to translate the format properties into css string. Required result flag to use this method is DssXmlResultGrid.

Returns

public abstract String getDatamartTableName ()

Returns the datamart table name used in this report.

Returned from XSL search pattern: "/mi/rit/dmt/@dmtn".

Required result flag to use this method is DssXmlResultDatamartTableName

Returns
  • The datamart table name of the report.

public abstract int getDrillOptions ()

Allows a user to extract the value of the Drilling Options. If not present, this method returns zero (0).

Returns
  • Integer value of the "Drilling Options" property.

    The XSL search pattern used to return this value is "/mi/rit/vw/prs/pr[@n = 'DrillingOptions']/@dft".

    Required result flag to use this method is DssXmlResultXmlDisplayProperties.

public abstract boolean getEnableReportDrilling ()

Returns whether or not the drill option is enabled. Required result flag to use this method is DssXmlResultXmlDisplayProperties.

Returns
  • True if drilling enabled.

public abstract String getErrorInGraph ()

Returns an error number returned when attempting to execute a graph.

Returned from XSL pattern search: "/mi/rit/vw/vws/gpp/@en".

Required result flag to use this method is DssXmlResultGraph or DssXmlResultGrid.

Returns
  • A string value of the error number.

public abstract String getFilterDetails ()

public abstract String getFilterExpressionDescriptor ()

public abstract String getFilterExpressionDetails ()

public abstract String getFilterExpressionViewDescriptor ()

public abstract WebFolder getFolder ()

Returns the parent folder of this report as a WebFolder object. Required result flag to use this method is DssXmlResultFolderPath.

Returns
  • Parent Folder of the report. null if pattern corresponding to the folder is not found.

public abstract String getFolderID ()

Returns the ID of the parent folder of this report.

Returned from XSL search pattern: "/mi/in/oi[@id = /mi/fd/@rfd]/@did".

Required result flag to use this method is DssXmlResultFolderPath.

Returns
  • Value of the folder ID. "" if search pattern is not found.

public abstract String getFolderName ()

Returns the name of the parent folder of this report.

Returned from XSL search pattern: "/mi/in/oi[@id = /mi/fd/@rfd]/@n".

Required result flag to use this method is DssXmlResultFolderPath.

Returns
  • Value of the folder name. "" if search pattern is not found.

public abstract WebGraphProperties getGraphProperties ()

Returns the graph properties for the report.

Returns
Throws
WebObjectsException Thrown if there is an error getting the graph Properties.

public abstract int getGraphTotalColumns ()

Returns the total number of columns in this graph report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gpp/@tc".

Required result flag to use this method is DssXmlResultGraph or DssXmlResultGrid.

Returns
  • The total number of columns in this report.

public abstract int getGraphTotalRows ()

Returns the total number of rows in this graph report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gpp/@tr".

Required result flag to use this method is DssXmlResultGraph or DssXmlResultGrid.

Returns
  • The total number of rows in this report.

public abstract int getGraphTypesAvailable ()

Returns the available graph types for this particular report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gpp/@gta".

Required result flag to use this method is DssXmlResultGraph or DssXmlResultGrid.

Returns

public abstract String getGridStyle ()

Returns the grid style of the current report. This is set via the window_settings tag or via the DSSXMLResultSet.SetGridProperty method call.

Returned from XSL search pattern: "/mi/rit/vw/vws/gdp/@gds".

Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.

Returns
  • String representing the grid style of the current report.

public abstract int getGridTotalColumnBlocks ()

public abstract int getGridTotalColumns ()

Returns the total number of columns in this grid report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gdp/@tc".

Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.

Returns
  • The total number of columns in this report or zero if the node is not available.

public abstract int getGridTotalRowBlocks ()

public abstract int getGridTotalRows ()

Returns the total number of rows in this grid report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gdp/@tr".

Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.

Returns
  • The total number of columns in this report or zero if the node is not available.

public abstract String getJobID ()

Returns the job ID when this report gets executed in the Intelligence Server.

Returns
  • the job ID of the report.

public abstract String getLastUpdate ()

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

Returned from XSL search pattern: "/mi/rit/@rut".

Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.

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

public abstract String getMetricConditionality (String dssid)

Returns a string representing the conditionality of a metric on the report. Note that this infomation will only be available if certain result flags are set when retrieving the report execution results. Required result flag to use this method is DssXmlResultDtlsTemplateUnits.

Parameters
dssid The object ID of the metric to return the conditionality for.
Returns
  • A string describing the conditionality of the metric.

public abstract String getMetricFormula (String dssid)

Returns a string representing the formula of a metric on the report. Note that this infomation will only be available if certain result flags are set when retrieving the report execution results. Required result flag to use this method is DssXmlResultDtlsTemplateUnits.

Parameters
dssid The object ID of the metric to return the formula for.
Returns
  • A string describing the formula of the metric.

public abstract String getMetricsLimit ()

Returns the limit information set on the metrics of the report. Required result flag to use this method is DssXmlResultDtlsTemplateLimit.

Returns
  • A description of the metrics limit information.

public abstract String getOriginalReportID ()

Returns the ID of the original report after report manipulation may have occurred.

Returned from XSL search pattern: "/mi/rit/ord/mi/in/oi/@did".

Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.

Returns
  • The ID of the original report.

public abstract String getPromptDetails ()

public abstract String getReportDescription ()

Returns report description of the current report instance.

Returns
  • The description of the current report.

public abstract String getReportDetails ()

public abstract String getReportFilterName ()

Returns the name of the report filter. Use only if report filter is linked.

Returns
  • returns the name of the report filter.

public abstract String getReportID ()

Returns report ID of the current report instance.

Returned from XSL search pattern: "/mi/rit/rd/mi/in/oi/@did".

Returns
  • The ID of the current report.

public abstract String getReportName ()

Returns report name of the current report instance.

Returned from XSL search pattern: "/mi/in/oi[position() = 0]/@n".

Returns
  • The name of the current report.

public abstract String getReportPath ()

Returns the folder path to the current report.

Returned from XSL search pattern: "/mi/fd/mi".

Required result flag to use this method is DssXmlResultFolderPath.

Returns
  • The folder path of the current report.

public abstract WebProperties getReportProperties ()

Returns the report properties.

Returns
Throws
WebObjectsException Thrown if there is an error getting the report Properties.

public abstract String getReportTemplateName ()

Returns the name of the report template. Use only if report template is linked.

Returns
  • returns the name of the report template.

public abstract String getReportType ()

This method is deprecated.
this now maps to getRequestType()

Returns the type of the type of the current report.

Returned from XSL search pattern: "/mi/im/@rtp".

Required result flag to use this method is DssXmlResultInboxMessage.

Returns
  • The type of the current report from the inbox message.

public abstract int getRequestType ()

Returns the type of the type of the current report.

Returned from XSL search pattern: "/mi/im/@rtp".

Required result flag to use this method is DssXmlResultInboxMessage.

Returns
  • The type of the current report from the inbox message.

public abstract WebResultWindow getResultWindow ()

Gets the WebResultWindow object, which contains information about the report result window. Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph

Returns

public abstract String getSQL ()

Returns the SQL for the current report.

Returned from XSL search pattern: "/mi/rit/sqls/sql/text()".

Required result flag to use this method is DssXmlResultXmlSQL.

Returns
  • The SQL of the current report.

public abstract String getTemplateDetails ()

public abstract String getTemplateLimit ()

This method is deprecated.
Please use getMetricsLimit instead. Required result flag to use this method is DssXmlResultDtlsTemplateLimit.

Returns the template limit information for the current report. This value is obtained when a certain flag is set when getting results.

Returns
  • A description of the template limit information.

public abstract String getTemplateLimitDescriptor ()

public abstract String getTemplateLimitViewDescriptor ()

public abstract String getTemplateName ()

Returns the template name for the current report.

Returned from XSL search pattern: "/mi/in/oi[@tp=\"2\"]/@n".

Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.

Returns
  • The template name of the current report.

public abstract WebFolder getTemplateObjects ()

Returns a WebFolder object containing information about all objects found on the template (metrics, attributes, etc). Note that this will only be returned by the Intelligence Server if certain result flags are set. Required result flag to use this method is DssXmlResultDtlsTemplateUnits.

Returns
Throws
WebObjectsException Thrown when error occurs in creating these objects.

public abstract String getTemplateUnitsLimit ()

This method returns the summary of the limit information set on the individual units of the base template. Required result flag to use this method is DssXmlResultDtlsTemplateLimit.

Returns
  • A description of the template units limit information.

public abstract int getType ()

Returns the type of the type of the current report. A value from EnumDSSXMLReportTypes

Returns
  • The type of the current report.

public abstract String getViewFilterDetails ()

This method is deprecated.
Not used

Returns the filter details for the view report.

Returned from XSL pattern search: "/mi/rit/view_report/view_filter/f/mi/exp[position()=1]/text()".

Required result flag to use this method is DssXmlResultViewReport.

Returns
  • A string value of the filter details for the view report.

public abstract String getViewMode ()

Returns the view mode for the current report. This specifies whether the report is viewed as a grid, a graph or both.

Returned from XSL search pattern: "/mi/rit/vw/vws/@vm".

Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.

Returns
  • The view mode of the current report.

public abstract String getViewTemplateLimit ()

Returns the template metric limit for the view report. This value is obtained when a certain flag is set when getting results. Required result flag to use this method is DssXmlResultDtlsTemplateLimit.

Returns
  • A description of the template metric limit for view.

public abstract WebReportGrid getWebReportGrid ()

Returns the report grid. Required result flag to use this method is DssXmlResultGrid

Returns
  • report grid
Throws
WebObjectsException thrown if a problem occurs during retrieval

public abstract String getXML ()

Returns the report result XML.

Returns
  • A string representing the complete XML from the report result.

public abstract boolean hasMetrics ()

Returns whether the report contains any metrics. Required result flag to use this method is DssXmlResultGrid

Returns
  • True if the report contains metrics, false otherwise.

public abstract boolean isChartAvailable ()

Returns whether or not a chart is available for this report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gpp/@ica".

Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.

Returns
  • True if chart is available.

public abstract boolean isDrillKeepParent ()

Returns whether or not the user has specified to keep parent attribute while drilling.

Returned from XSL search pattern: "/mi/rit/vw/prs/pr[@n='DrillingKeepParent']/@dft".

Required result flag to use this method is DssXmlResultXmlDisplayProperties.

Returns
  • True if the user has specified to keep parent attribute while drilling.

public abstract boolean isDrilledReport ()

Returns whether or not this report is the result of a drill operation.

Returned from XSL search pattern: "/mi/rit/rsl/mi/in/oi[@tp='10']/mi/pif[@usd='1']".

Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.

Returns
  • True if this report is the result of a drill, false if otherwise.

public abstract boolean isPromptedReport (boolean includeDormant)

Returns whether or not this report is the result of a prompt operation. If the DssXmlResultNoResolution result flag was set on the Report while fetching the execution results, this information is not reliable, as the corresponding XML is not returned in the report XML. The use of isPrompted() on WebReportInstance is instead reliable for all cases.

Parameters
includeDormant Determines whether dormant prompts should be considered when determining whether the report is prompted or not. Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.
Returns
  • True if the report is the result of a prompt, false if otherwise.

public abstract boolean isPromptedReport ()

Returns whether or not this report is the result of a prompt operation. If the DssXmlResultNoResolution result flag was set on the Report while fetching the execution results, this information is not reliable, as the corresponding XML is not returned in the report XML. The use of isPrompted() on WebReportInstance is instead reliable for all cases. This method will not consider a report with only dormant prompts prompted; use the method with the includeDormant parameter for a different behavior.

Returned from XSL search pattern: "/mi/rit/rsl/mi/in/oi[@tp='10']/mi/pif[@usd='1']" Required result flag to use this method is DssXmlResultGrid or DssXmlResultGraph.

Returns
  • True if the report is the result of a prompt, false if otherwise.

public abstract boolean isReportFilterLinked ()

Returns true if the report filter is linked.

Returns
  • true if the report filter is linked.

public abstract boolean isReportTemplateLinked ()

Returns true if the report template is linked.

Returns
  • true if the report template is linked.

public abstract boolean isReportTruncated ()

Returns whether or not this report is truncated. A truncated report would indicate that not all rows have been returned to in the result XML due to the window settings.

Returned from XSL search pattern: "/mi/rit/vw/gr/@xmn".

Required result flag to use this method is DssXmlResultGrid.

Returns
  • True if the report is truncated.

public abstract boolean isShowBanding ()

Returns whether the report is currently shown in banding mode. Required result flag to use this method is DssXmlResultXmlDisplayProperties

Returns
  • True if the report is a banding report, false otherwise.

public abstract boolean isTotalAvailable ()

Returns whether or not totals are available for this report.

Returned from XSL search pattern: "/mi/rit/vw/gr/@sr".

Required result flag to use this method is DssXmlResultGrid.

Returns
  • True if the totals are available.