public interface

WebResultWindow

implements EnumIFMode
com.microstrategy.web.objects.WebResultWindow

Class Overview

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 from WebReportInstance and WebReportSource.

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 a WebProperty which is saved along with a report definition in the MetaData database. They need to be re-set next time executing the same report.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.objects.EnumIFMode
Public Methods
abstract void clear()
Resets all the properties of the result window to the default values.
abstract int getGraphMaxCols()
Returns the maximum number of columns to send for a graph report.
abstract int getGraphMaxDataPointsCols()
Returns the number of data points on the columns that are returned for the graph labels.
abstract int getGraphMaxDataPointsRows()
Returns the number of data points on the rows that are returned for the graph labels.
abstract int getGraphMaxRows()
Returns the maximum number of rows to send for a graph report.
abstract int getGraphStartCol()
Returns the current setting for starting graph column.
abstract int getGraphStartRow()
Returns the current setting for starting graph row.
abstract int getGridColMode()
abstract int getGridMaxCols()
Returns the maximum number of columns to send for a grid report.
abstract int getGridMaxRows()
Returns the maximum number of rows to send for a grid report.
abstract int getGridRowMode()
abstract int getGridStartCol()
Returns the current setting for starting grid column.
abstract int getGridStartRow()
Returns the current setting for starting grid row.
abstract void setGraphMaxCols(int graphMaxCols)
Sets the maximum number of columns to send for a graph report.
abstract void setGraphMaxDataPointsCols(int graphDataPointsCols)
Sets the number of data points on the columns that are needed for the graph labels.
abstract void setGraphMaxDataPointsRows(int graphDataPointsRows)
Sets the number of data points on the rows that are needed for the graph labels.
abstract void setGraphMaxRows(int graphMaxRows)
Sets the maximum number of rows to send for a graph report.
abstract void setGraphStartCol(int graphStartCol)
Sets the starting column for a graph report.
abstract void setGraphStartRow(int graphStartRow)
Sets the starting row for a graph report.
abstract void setGridColMode(int gridColMode)
abstract void setGridMaxCols(int gridMaxCols)
Sets the maximum number of columns to send for a grid report.
abstract void setGridMaxRows(int gridMaxRows)
Sets the maximum number of rows to send for a grid report.
abstract void setGridRowMode(int gridRowMode)
abstract void setGridStartCol(int gridStartCol)
Sets the starting column for a grid report.
abstract void setGridStartRow(int gridStartRow)
Sets the starting grid row to the given value.
abstract void setNorifyParent(boolean value)

Public Methods

public abstract void clear ()

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
UnsupportedOperationException if trying to modify a read-only object.

public abstract 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

public abstract 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

public abstract 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

public abstract 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

public abstract 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

public abstract 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

public abstract int getGridColMode ()

public abstract 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

public abstract 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

public abstract int getGridRowMode ()

public abstract 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

public abstract 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

public abstract void setGraphMaxCols (int graphMaxCols)

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
UnsupportedOperationException if trying to modify a read-only object.
See Also

public abstract void setGraphMaxDataPointsCols (int graphDataPointsCols)

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.

Throws
UnsupportedOperationException
UnsupportedOperationException

public abstract void setGraphMaxDataPointsRows (int graphDataPointsRows)

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.

Throws
UnsupportedOperationException
UnsupportedOperationException

public abstract void setGraphMaxRows (int graphMaxRows)

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
UnsupportedOperationException if trying to modify a read-only object.
See Also

public abstract void setGraphStartCol (int graphStartCol)

Sets the starting column for a graph report.

Parameters
graphStartCol The first column which should appear on the graph report.
Throws
UnsupportedOperationException if trying to modify a read-only object.
See Also

public abstract void setGraphStartRow (int graphStartRow)

Sets the starting row for a graph report.

Parameters
graphStartRow The first row which should appear on the report.
Throws
UnsupportedOperationException if trying to modify a read-only object.
See Also

public abstract void setGridColMode (int gridColMode)

public abstract void setGridMaxCols (int gridMaxCols)

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
UnsupportedOperationException if trying to modify a read-only object.
See Also

public abstract void setGridMaxRows (int gridMaxRows)

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
UnsupportedOperationException if trying to modify a read-only object.
See Also

public abstract void setGridRowMode (int gridRowMode)

public abstract void setGridStartCol (int gridStartCol)

Sets the starting column for a grid report.

Parameters
gridStartCol The first column which should appear on the grid report.
Throws
UnsupportedOperationException if trying to modify a read-only object.
See Also

public abstract void setGridStartRow (int gridStartRow)

Sets the starting grid row to the given value.

Parameters
gridStartRow The first row which should appear on the grid.
Throws
UnsupportedOperationException if trying to modify a read-only object.
See Also

public abstract void setNorifyParent (boolean value)