Package com.microstrategy.web.objects
Interface WebResultWindow
-
- All Superinterfaces:
EnumIFMode
public interface WebResultWindow extends EnumIFMode
The WebResultWindow interface allows the user to set the window of report results that the Intelligence Server should return. This object can only be obtained fromWebReportInstance
andWebReportSource
.Notice that WebResultWindow is per report basis, there are other settings affecting all reports' execution. The Governing Limit is about the maximum number of XML cells the Intelligence Server can return when executing a report. Report Limit is on project level about the maximum number of rows a report grid can return.
The properties on this interface are persisted in the state of each
WebReportInstance
, but not as aWebProperty
which is saved along with a report definition in the MetaData database. They need to be re-set next time executing the same report.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.objects.EnumIFMode
IF_MODE_BLOCKS, IF_MODE_COLUMNS, IF_MODE_ROWS, IF_MODE_UNKNOWN, IF_MODE_USE_PREFERENCES, IF_MODE_USE_PROPERTIES
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clear()
Resets all the properties of the result window to the default values.int
getGraphMaxCols()
Returns the maximum number of columns to send for a graph report.int
getGraphMaxDataPointsCols()
Returns the number of data points on the columns that are returned for the graph labels.int
getGraphMaxDataPointsRows()
Returns the number of data points on the rows that are returned for the graph labels.int
getGraphMaxRows()
Returns the maximum number of rows to send for a graph report.int
getGraphStartCol()
Returns the current setting for starting graph column.int
getGraphStartRow()
Returns the current setting for starting graph row.int
getGridColMode()
int
getGridMaxCols()
Returns the maximum number of columns to send for a grid report.int
getGridMaxRows()
Returns the maximum number of rows to send for a grid report.int
getGridPageByMaxRows()
Returns the maximum number of pageBy rows to send for a grid report.int
getGridPageByStartRow()
Returns the pageBy start row to send for a grid report.int
getGridRowMode()
int
getGridStartCol()
Returns the current setting for starting grid column.int
getGridStartRow()
Returns the current setting for starting grid row.void
setGraphMaxCols(int graphMaxCols)
Sets the maximum number of columns to send for a graph report.void
setGraphMaxDataPointsCols(int graphDataPointsCols)
Sets the number of data points on the columns that are needed for the graph labels.void
setGraphMaxDataPointsRows(int graphDataPointsRows)
Sets the number of data points on the rows that are needed for the graph labels.void
setGraphMaxRows(int graphMaxRows)
Sets the maximum number of rows to send for a graph report.void
setGraphStartCol(int graphStartCol)
Sets the starting column for a graph report.void
setGraphStartRow(int graphStartRow)
Sets the starting row for a graph report.void
setGridColMode(int gridColMode)
void
setGridMaxCols(int gridMaxCols)
Sets the maximum number of columns to send for a grid report.void
setGridMaxRows(int gridMaxRows)
Sets the maximum number of rows to send for a grid report.void
setGridPageByMaxRows(int gridMaxPageBys)
Sets the maximum number of pageBy rows to send for a grid report.void
setGridPageByStartRow(int gridStartPageBy)
Sets the pageBy start row to send for a grid report.void
setGridRowMode(int gridRowMode)
void
setGridStartCol(int gridStartCol)
Sets the starting column for a grid report.void
setGridStartRow(int gridStartRow)
Sets the starting grid row to the given value.void
setNorifyParent(boolean value)
-
-
-
Method Detail
-
getGridRowMode
int getGridRowMode()
-
setGridRowMode
void setGridRowMode(int gridRowMode)
-
getGridColMode
int getGridColMode()
-
setGridColMode
void setGridColMode(int gridColMode)
-
getGridStartRow
int getGridStartRow()
Returns the current setting for starting grid row.- Returns:
- The current setting of the first row which should appear on the grid.
- See Also:
setGridStartRow(int)
-
setGridStartRow
void setGridStartRow(int gridStartRow) throws java.lang.UnsupportedOperationException
Sets the starting grid row to the given value.- Parameters:
gridStartRow
- The first row which should appear on the grid.- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.- See Also:
getGridStartRow()
-
getGridMaxRows
int getGridMaxRows()
Returns the maximum number of rows to send for a grid report.- Returns:
- The current setting of the maximum number of rows to return for the grid report.
- See Also:
setGridMaxRows(int)
-
setGridMaxRows
void setGridMaxRows(int gridMaxRows) throws java.lang.UnsupportedOperationException
Sets the maximum number of rows to send for a grid report.- Parameters:
gridMaxRows
- The maximum number of rows to return from the report. If 0, all rows will be included in the grid report. If -1, the default report value will be used (i.e. the value that was used when the report was executed, or refreshed).- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.- See Also:
getGridMaxRows()
-
getGridStartCol
int getGridStartCol()
Returns the current setting for starting grid column.- Returns:
- The current setting of the first column which should appear on the grid report.
- See Also:
setGridStartCol(int)
-
setGridStartCol
void setGridStartCol(int gridStartCol) throws java.lang.UnsupportedOperationException
Sets the starting column for a grid report.- Parameters:
gridStartCol
- The first column which should appear on the grid report.- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.- See Also:
getGridStartCol()
-
getGridMaxCols
int getGridMaxCols()
Returns the maximum number of columns to send for a grid report.- Returns:
- The current setting of the maximum number of columns to return for the grid report.
- See Also:
setGridMaxCols(int)
-
setGridMaxCols
void setGridMaxCols(int gridMaxCols) throws java.lang.UnsupportedOperationException
Sets the maximum number of columns to send for a grid report.- Parameters:
gridMaxCols
- The maximum number of columns to return from the report. If 0, all columns will be included in the grid report. If -1, the default report value will be used (i.e. the value that was used when the report was executed, or refreshed).- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.- See Also:
getGridMaxCols()
-
getGraphStartRow
int getGraphStartRow()
Returns the current setting for starting graph row.- Returns:
- The current setting of the first row which should appear on the graph report.
- See Also:
setGraphStartRow(int)
-
setGraphStartRow
void setGraphStartRow(int graphStartRow) throws java.lang.UnsupportedOperationException
Sets the starting row for a graph report.- Parameters:
graphStartRow
- The first row which should appear on the report.- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.- See Also:
getGraphStartRow()
-
getGraphMaxRows
int getGraphMaxRows()
Returns the maximum number of rows to send for a graph report.- Returns:
- The current setting of the maximum number of rows to return for the graph report.
- See Also:
setGraphMaxRows(int)
-
setGraphMaxRows
void setGraphMaxRows(int graphMaxRows) throws java.lang.UnsupportedOperationException
Sets the maximum number of rows to send for a graph report.- Parameters:
graphMaxRows
- The maximum number of rows to return from the report. If 0, all rows will be included in the graph report. If -1, the default report value will be used (i.e. the value that was used when the report was executed, or refreshed).- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.- See Also:
getGraphMaxRows()
-
getGraphStartCol
int getGraphStartCol()
Returns the current setting for starting graph column.- Returns:
- the current setting of the first column which should appear on the graph report.
- See Also:
setGraphStartCol(int)
-
setGraphStartCol
void setGraphStartCol(int graphStartCol) throws java.lang.UnsupportedOperationException
Sets the starting column for a graph report.- Parameters:
graphStartCol
- The first column which should appear on the graph report.- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.- See Also:
getGraphStartCol()
-
getGraphMaxCols
int getGraphMaxCols()
Returns the maximum number of columns to send for a graph report.- Returns:
- The current setting of the maximum number of columns to return for the graph report.
- See Also:
setGraphMaxCols(int)
-
setGraphMaxCols
void setGraphMaxCols(int graphMaxCols) throws java.lang.UnsupportedOperationException
Sets the maximum number of columns to send for a graph report.- Parameters:
graphMaxCols
- The maximum number of columns to return from the report. If 0, all columns will be included in the graph report. If -1, the default report value will be used (i.e. the value that was used when the report was executed, or refreshed).- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.- See Also:
getGraphMaxCols()
-
getGridPageByStartRow
int getGridPageByStartRow()
Returns the pageBy start row to send for a grid report. Note: This value would be lost if the object has been serialized then deserialized, because this value wouldn't be serialized in the current implementation to avoid regression issue.- Returns:
- The current setting of the start pageBy to return for the grid report.
- See Also:
setGridPageByStartRow(int)
-
setGridPageByStartRow
void setGridPageByStartRow(int gridStartPageBy) throws java.lang.UnsupportedOperationException
Sets the pageBy start row to send for a grid report. Note: This value wouldn't be serialized in the current implementation to avoid regression issue.- Parameters:
gridStartPageBy
- The first pageBy which appears on the grid report.- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.- See Also:
getGridPageByStartRow()
-
getGridPageByMaxRows
int getGridPageByMaxRows()
Returns the maximum number of pageBy rows to send for a grid report. Note: This value would be lost if the object has been serialized then deserialized, because this value wouldn't be serialized in the current implementation to avoid regression issue.- Returns:
- The current setting of the maximum number of pageBys to return for the grid report.
- See Also:
setGridPageByMaxRows(int)
-
setGridPageByMaxRows
void setGridPageByMaxRows(int gridMaxPageBys) throws java.lang.UnsupportedOperationException
Sets the maximum number of pageBy rows to send for a grid report. Note: This value wouldn't be serialized in the current implementation to avoid regression issue.- Parameters:
gridMaxPageBys
- The maximum number of pageBys to return from the report. If -1, it would return all the pageBys owned by this grid report.- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.- See Also:
getGridPageByMaxRows()
-
clear
void clear() throws java.lang.UnsupportedOperationException
Resets all the properties of the result window to the default values. The defaults are: Grid start row (1), Grid max rows (-1), Grid start col(1), Grid max cols (-1), Graph start row (1), Graph max rows (-1), Graph start col(1), Graph max cols(-1).- Throws:
java.lang.UnsupportedOperationException
- if trying to modify a read-only object.
-
setGraphMaxDataPointsRows
void setGraphMaxDataPointsRows(int graphDataPointsRows) throws java.lang.UnsupportedOperationException
Sets the number of data points on the rows that are needed for the graph labels. The actual number of labels returned is this number plus 1 since we always include the first and last row. By default, if this value is not specified, the number of labels returned is determined by the intelligence server and by the size of the graph.- Parameters:
graphDataPointsRows
-- Throws:
java.lang.UnsupportedOperationException
- Since:
- MicroStrategy Web 9.0.0
-
setGraphMaxDataPointsCols
void setGraphMaxDataPointsCols(int graphDataPointsCols) throws java.lang.UnsupportedOperationException
Sets the number of data points on the columns that are needed for the graph labels. The actual number of labels returned is this number plus 1 since we always include the first and last column. By default, if this value is not specified, the number of labels returned is determined by the intelligence server and by the size of the graph.- Parameters:
graphDataPointsCols
-- Throws:
java.lang.UnsupportedOperationException
- Since:
- MicroStrategy Web 9.0.0
-
getGraphMaxDataPointsRows
int getGraphMaxDataPointsRows()
Returns the number of data points on the rows that are returned for the graph labels. The default value is '-1' which means that the actual number is determined by Intelligence server- Since:
- MicroStrategy Web 9.0.0
-
getGraphMaxDataPointsCols
int getGraphMaxDataPointsCols()
Returns the number of data points on the columns that are returned for the graph labels. The default value is '-1' which means that the actual number is determined by Intelligence server- Since:
- MicroStrategy Web 9.0.0
-
setNorifyParent
void setNorifyParent(boolean value)
-
-