Interface WebReportData
-
- All Superinterfaces:
WebGraph
,WebGridData
public interface WebReportData extends WebGridData, WebGraph
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.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getBaseFilterDetails()
Deprecated.use a transform (e.g.java.lang.String
getBaseFilterName()
Returns the name of the base filter within the current report.WebCSSHelper
getCSSHelper()
Returns the WebCSSHelper object, which can be used to translate the format properties into css string.java.lang.String
getDatamartTableName()
Returns the datamart table name used in this report.int
getDrillOptions()
Allows a user to extract the value of the Drilling Options.boolean
getEnableReportDrilling()
Returns whether or not the drill option is enabled.java.lang.String
getErrorInGraph()
Returns an error number returned when attempting to execute a graph.java.lang.String
getFilterDetails()
java.lang.String
getFilterExpressionDescriptor()
java.lang.String
getFilterExpressionDetails()
java.lang.String
getFilterExpressionViewDescriptor()
WebFolder
getFolder()
Returns the parent folder of this report as aWebFolder
object.java.lang.String
getFolderID()
Returns the ID of the parent folder of this report.java.lang.String
getFolderName()
Returns the name of the parent folder of this report.WebGraphProperties
getGraphProperties()
Returns the graph properties for the report.int
getGraphTotalColumns()
Returns the total number of columns in this graph report.int
getGraphTotalRows()
Returns the total number of rows in this graph report.int
getGraphTypesAvailable()
Returns the available graph types for this particular report.java.lang.String
getGridStyle()
Returns the grid style of the current report.int
getGridTotalColumnBlocks()
int
getGridTotalColumns()
Returns the total number of columns in this grid report.int
getGridTotalRowBlocks()
int
getGridTotalRows()
Returns the total number of rows in this grid report.java.lang.String
getJobID()
Returns the job ID when this report gets executed in the Intelligence Server.java.lang.String
getLastUpdate()
Returns the time and date when this report was last updated against the warehouse.java.lang.String
getMetricConditionality(java.lang.String dssid)
Returns a string representing the conditionality of a metric on the report.java.lang.String
getMetricFormula(java.lang.String dssid)
Returns a string representing the formula of a metric on the report.java.lang.String
getMetricsLimit()
Returns the limit information set on the metrics of the report.java.lang.String
getOriginalReportID()
Returns the ID of the original report after report manipulation may have occurred.java.lang.String
getPromptDetails()
java.lang.String
getReportDescription()
Returns report description of the current report instance.java.lang.String
getReportDetails()
java.lang.String
getReportFilterName()
Returns the name of the report filter.java.lang.String
getReportID()
Returns report ID of the current report instance.java.lang.String
getReportName()
Returns report name of the current report instance.java.lang.String
getReportPath()
Returns the folder path to the current report.WebProperties
getReportProperties()
Returns the report properties.java.lang.String
getReportTemplateName()
Returns the name of the report template.java.lang.String
getReportType()
Deprecated.this now maps togetRequestType()
int
getRequestType()
Returns the type of the type of the current report.WebResultWindow
getResultWindow()
Gets the WebResultWindow object, which contains information about the report result window.java.lang.String
getSQL()
Returns the SQL for the current report.java.lang.String
getTemplateDetails()
java.lang.String
getTemplateLimit()
Deprecated.Please use getMetricsLimit instead.java.lang.String
getTemplateLimitDescriptor()
java.lang.String
getTemplateLimitViewDescriptor()
java.lang.String
getTemplateName()
Returns the template name for the current report.WebFolder
getTemplateObjects()
Returns aWebFolder
object containing information about all objects found on the template (metrics, attributes, etc).java.lang.String
getTemplateUnitsLimit()
This method returns the summary of the limit information set on the individual units of the base template.int
getType()
Returns the type of the type of the current report.java.lang.String
getViewFilterDetails()
Deprecated.Not usedjava.lang.String
getViewMode()
Returns the view mode for the current report.java.lang.String
getViewTemplateLimit()
Returns the template metric limit for the view report.WebReportGrid
getWebReportGrid()
Returns the report grid.java.lang.String
getXML()
Returns the report result XML.boolean
hasMetrics()
Returns whether the report contains any metrics.boolean
isChartAvailable()
Returns whether or not a chart is available for this report.boolean
isDrilledReport()
Returns whether or not this report is the result of a drill operation.boolean
isDrillKeepParent()
Returns whether or not the user has specified to keep parent attribute while drilling.boolean
isPromptedReport()
Returns whether or not this report is the result of a prompt operation.boolean
isPromptedReport(boolean includeDormant)
Returns whether or not this report is the result of a prompt operation.boolean
isReportFilterLinked()
Returns true if the report filter is linked.boolean
isReportTemplateLinked()
Returns true if the report template is linked.boolean
isReportTruncated()
Returns whether or not this report is truncated.boolean
isShowBanding()
Returns whether the report is currently shown in banding mode.boolean
isTotalAvailable()
Returns whether or not totals are available for this report.-
Methods inherited from interface com.microstrategy.web.objects.WebGraph
getAutosizeHorizontal, getAutosizeVertical, getCategories, getCoordinateString, getData, getData, getGraphAreas, getGraphProperties, getHeight, getImageType, getLoadCoordinate, getMajorType, getMinorType, getSeries, getWidth, isLinkedToControl, saveToDisk, setAutosizeHorizontal, setAutosizeVertical, setHeight, setImageType, setLoadCoordinate, setMajorType, setMinorType, setWidth
-
Methods inherited from interface com.microstrategy.web.objects.WebGridData
getErrorMsg, getGraphAreas, getMarkedRowIndices, getNoDataCustomMessage, hasSubtotals
-
-
-
-
Method Detail
-
getViewMode
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Returns:
- The view mode of the current report.
-
getGraphTotalColumns
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 isEnumDSSXMLResultFlags.DssXmlResultGraph
orEnumDSSXMLResultFlags.DssXmlResultGrid
.- Specified by:
getGraphTotalColumns
in interfaceWebGraph
- Returns:
- The total number of columns in this report.
-
getGraphTotalRows
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 isEnumDSSXMLResultFlags.DssXmlResultGraph
orEnumDSSXMLResultFlags.DssXmlResultGrid
.- Specified by:
getGraphTotalRows
in interfaceWebGraph
- Returns:
- The total number of rows in this report.
-
getGraphTypesAvailable
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 isEnumDSSXMLResultFlags.DssXmlResultGraph
orEnumDSSXMLResultFlags.DssXmlResultGrid
.- Specified by:
getGraphTypesAvailable
in interfaceWebGraph
- Returns:
- The graph types available represented as a bit-wise OR of the
EnumDSSXMLMajorGraphTypes
enumeration.
-
getErrorInGraph
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultGraph
orEnumDSSXMLResultFlags.DssXmlResultGrid
.- Specified by:
getErrorInGraph
in interfaceWebGraph
- Returns:
- A string value of the error number.
-
getGridStyle
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Returns:
- String representing the grid style of the current report.
-
getGridTotalColumns
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 isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Specified by:
getGridTotalColumns
in interfaceWebGridData
- Returns:
- The total number of columns in this report or zero if the node is not available.
-
getGridTotalRows
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 isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Specified by:
getGridTotalRows
in interfaceWebGridData
- Returns:
- The total number of columns in this report or zero if the node is not available.
-
getDrillOptions
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 isEnumDSSXMLResultFlags.DssXmlResultXmlDisplayProperties
.
-
getEnableReportDrilling
boolean getEnableReportDrilling()
Returns whether or not the drill option is enabled. Required result flag to use this method isEnumDSSXMLResultFlags.DssXmlResultXmlDisplayProperties
.- Returns:
- True if drilling enabled.
-
isChartAvailable
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 isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Specified by:
isChartAvailable
in interfaceWebGraph
- Returns:
- True if chart is available.
-
isDrilledReport
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 isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Returns:
- True if this report is the result of a drill, false if otherwise.
-
isDrillKeepParent
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 isEnumDSSXMLResultFlags.DssXmlResultXmlDisplayProperties
.- Returns:
- True if the user has specified to keep parent attribute while drilling.
-
isPromptedReport
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() onWebReportInstance
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
EnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Returns:
- True if the report is the result of a prompt, false if otherwise.
-
isPromptedReport
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() onWebReportInstance
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 isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Returns:
- True if the report is the result of a prompt, false if otherwise.
-
isReportTruncated
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 isEnumDSSXMLResultFlags.DssXmlResultGrid
.- Specified by:
isReportTruncated
in interfaceWebGridData
- Returns:
- True if the report is truncated.
-
isTotalAvailable
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 isEnumDSSXMLResultFlags.DssXmlResultGrid
.- Specified by:
isTotalAvailable
in interfaceWebGridData
- Returns:
- True if the totals are available.
-
getLastUpdate
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Returns:
- A string representing the last updated time and date.
-
getFolderID
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultFolderPath
.- Returns:
- Value of the folder ID. "" if search pattern is not found.
-
getFolder
WebFolder getFolder()
Returns the parent folder of this report as aWebFolder
object. Required result flag to use this method isEnumDSSXMLResultFlags.DssXmlResultFolderPath
.- Returns:
- Parent Folder of the report. null if pattern corresponding to the folder is not found.
-
getFolderName
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultFolderPath
.- Returns:
- Value of the folder name. "" if search pattern is not found.
-
getTemplateName
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Returns:
- The template name of the current report.
-
getTemplateObjects
WebFolder getTemplateObjects() throws WebObjectsException
Returns aWebFolder
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 isEnumDSSXMLResultFlags.DssXmlResultDtlsTemplateUnits
.- Returns:
- A
WebFolder
object containingWebObjectInfo
objects corresponding to every template object. - Throws:
WebObjectsException
- Thrown when error occurs in creating these objects.
-
getTemplateLimit
java.lang.String getTemplateLimit()
Deprecated.Please use getMetricsLimit instead. Required result flag to use this method isEnumDSSXMLResultFlags.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.
-
getMetricsLimit
java.lang.String getMetricsLimit()
Returns the limit information set on the metrics of the report. Required result flag to use this method isEnumDSSXMLResultFlags.DssXmlResultDtlsTemplateLimit
.- Returns:
- A description of the metrics limit information.
- Since:
- MicroStrategy Web 8.0.0
-
getTemplateUnitsLimit
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultDtlsTemplateLimit
.- Returns:
- A description of the template units limit information.
- Since:
- MicroStrategy Web 8.0.0
-
getViewTemplateLimit
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultDtlsTemplateLimit
.- Returns:
- A description of the template metric limit for view.
-
getBaseFilterName
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultWorkingSet
.- Returns:
- The base filter name.
-
getBaseFilterDetails
java.lang.String getBaseFilterDetails()
Deprecated.use a transform (e.g.com.microstrategy.web.app.transforms.ExpressionPlainTextTransform
) to display the working set filter expressionReturns 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 isEnumDSSXMLResultFlags.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.
-
getViewFilterDetails
java.lang.String getViewFilterDetails()
Deprecated.Not usedReturns 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 isEnumDSSXMLResultFlags.DssXmlResultViewReport
.- Returns:
- A string value of the filter details for the view report.
-
getMetricConditionality
java.lang.String getMetricConditionality(java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultDtlsTemplateUnits
.- Parameters:
dssid
- The object ID of the metric to return the conditionality for.- Returns:
- A string describing the conditionality of the metric.
-
getMetricFormula
java.lang.String getMetricFormula(java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultDtlsTemplateUnits
.- Parameters:
dssid
- The object ID of the metric to return the formula for.- Returns:
- A string describing the formula of the metric.
-
getOriginalReportID
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
.- Returns:
- The ID of the original report.
-
getReportDescription
java.lang.String getReportDescription()
Returns report description of the current report instance.- Returns:
- The description of the current report.
-
getReportID
java.lang.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.
-
getReportName
java.lang.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.
-
getReportPath
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultFolderPath
.- Returns:
- The folder path of the current report.
-
getReportType
java.lang.String getReportType()
Deprecated.this now maps togetRequestType()
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 isEnumDSSXMLResultFlags.DssXmlResultInboxMessage
.- Returns:
- The type of the current report from the inbox message.
-
getRequestType
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 isEnumDSSXMLResultFlags.DssXmlResultInboxMessage
.- Returns:
- The type of the current report from the inbox message.
- Since:
- MicroStrategy Web 8.0.2
-
getType
int getType()
Returns the type of the type of the current report. A value fromEnumDSSXMLReportTypes
- Returns:
- The type of the current report.
- Since:
- MicroStrategy Web 8.0.2
-
getSQL
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultXmlSQL
.- Returns:
- The SQL of the current report.
-
getXML
java.lang.String getXML()
Returns the report result XML.- Returns:
- A string representing the complete XML from the report result.
-
getCSSHelper
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 isEnumDSSXMLResultFlags.DssXmlResultGrid
.- Specified by:
getCSSHelper
in interfaceWebGridData
- Returns:
- The
WebCSSHelper
object for this report data.
-
getResultWindow
WebResultWindow getResultWindow()
Gets the WebResultWindow object, which contains information about the report result window. Required result flag to use this method isEnumDSSXMLResultFlags.DssXmlResultGrid
orEnumDSSXMLResultFlags.DssXmlResultGraph
- Specified by:
getResultWindow
in interfaceWebGraph
- Returns:
- The
WebResultWindow
object.
-
getGraphProperties
WebGraphProperties getGraphProperties() throws WebObjectsException
Returns the graph properties for the report.- Specified by:
getGraphProperties
in interfaceWebGraph
- Returns:
- The
WebGraphProperties
object, which contains the graph properties of the report. Required result flag to use this method isEnumDSSXMLResultFlags.DssXmlResultGraph
- Throws:
WebObjectsException
- Thrown if there is an error getting the graph Properties.
-
getReportProperties
WebProperties getReportProperties() throws WebObjectsException
Returns the report properties.- Returns:
- The
WebProperties
object. Required result flag to use this method isEnumDSSXMLResultFlags.DssXmlResultXmlDisplayProperties
- Throws:
WebObjectsException
- Thrown if there is an error getting the report Properties.
-
isShowBanding
boolean isShowBanding()
Returns whether the report is currently shown in banding mode. Required result flag to use this method isEnumDSSXMLResultFlags.DssXmlResultXmlDisplayProperties
- Specified by:
isShowBanding
in interfaceWebGridData
- Returns:
- True if the report is a banding report, false otherwise.
-
hasMetrics
boolean hasMetrics()
Returns whether the report contains any metrics. Required result flag to use this method isEnumDSSXMLResultFlags.DssXmlResultGrid
- Returns:
- True if the report contains metrics, false otherwise.
-
getDatamartTableName
java.lang.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 isEnumDSSXMLResultFlags.DssXmlResultDatamartTableName
- Returns:
- The datamart table name of the report.
-
getWebReportGrid
WebReportGrid getWebReportGrid() throws WebObjectsException
Returns the report grid. Required result flag to use this method isEnumDSSXMLResultFlags.DssXmlResultGrid
- Specified by:
getWebReportGrid
in interfaceWebGridData
- Returns:
- report grid
- Throws:
WebObjectsException
- thrown if a problem occurs during retrieval
-
isReportTemplateLinked
boolean isReportTemplateLinked()
Returns true if the report template is linked.- Returns:
- true if the report template is linked.
- Since:
- MicroStrategy Web 8.0.0
-
isReportFilterLinked
boolean isReportFilterLinked()
Returns true if the report filter is linked.- Returns:
- true if the report filter is linked.
- Since:
- MicroStrategy Web 8.0.0
-
getReportTemplateName
java.lang.String getReportTemplateName()
Returns the name of the report template. Use only if report template is linked.- Returns:
- returns the name of the report template.
- Since:
- MicroStrategy Web 8.0.0
-
getReportFilterName
java.lang.String getReportFilterName()
Returns the name of the report filter. Use only if report filter is linked.- Returns:
- returns the name of the report filter.
- Since:
- MicroStrategy Web 8.0.0
-
getJobID
java.lang.String getJobID()
Returns the job ID when this report gets executed in the Intelligence Server.- Returns:
- the job ID of the report.
- Since:
- MicroStrategy Web 8.0.0
-
getReportDetails
java.lang.String getReportDetails()
-
getFilterExpressionDescriptor
java.lang.String getFilterExpressionDescriptor()
- Since:
- MicroStrategy Web 9.0.0
-
getFilterExpressionDetails
java.lang.String getFilterExpressionDetails()
- Since:
- MicroStrategy Web 9.0.0
-
getFilterExpressionViewDescriptor
java.lang.String getFilterExpressionViewDescriptor()
- Since:
- MicroStrategy Web 9.0.0
-
getTemplateLimitDescriptor
java.lang.String getTemplateLimitDescriptor()
- Since:
- MicroStrategy Web 9.0.0
-
getTemplateLimitViewDescriptor
java.lang.String getTemplateLimitViewDescriptor()
- Since:
- MicroStrategy Web 9.0.0
-
getPromptDetails
java.lang.String getPromptDetails()
- Since:
- MicroStrategy Web 9.0.0
-
getTemplateDetails
java.lang.String getTemplateDetails()
- Since:
- MicroStrategy Web 9.0.0
-
getFilterDetails
java.lang.String getFilterDetails()
- Since:
- MicroStrategy Web 9.0.0
-
getGridTotalRowBlocks
int getGridTotalRowBlocks()
- Specified by:
getGridTotalRowBlocks
in interfaceWebGridData
-
getGridTotalColumnBlocks
int getGridTotalColumnBlocks()
- Specified by:
getGridTotalColumnBlocks
in interfaceWebGridData
-
-