ReportDisplay (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.process.analytics2.ReportDisplay

All Implemented Interfaces:

java.io.Serializable
```
public class ReportDisplay
extends java.lang.Object
implements java.io.Serializable
```
Bean detailing how an analytics report is to be displayed.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DISPLAY_BAR_CHART` Display the report as a bar chart.
`static int`	`DISPLAY_GANTT_CHART` Display the report as a Gantt chart.
`static int`	`DISPLAY_GRID_TABLE` Display the report at a table.
`static int`	`DISPLAY_HORIZONTAL_BAR_CHART` Display the report as a horizontal bar chart.
`static int`	`DISPLAY_HORIZONTAL_STACKED_CHART` Display the report as a horizontal stacked chart.
`static int`	`DISPLAY_LINE_CHART` Display the report as a line chart.
`static int`	`DISPLAY_PIE_CHART` Display the report as a pie chart.
`static int`	`DISPLAY_STACKED_CHART` Display the report as a stacked bar chart.
`static int`	`QUICK_FILTER_DROPDOWN` Display quick filters as dropdowns.
`static int`	`QUICK_FILTER_LINK` Display quick filters as links.

Constructor Summary

Constructors
Constructor and Description

ReportDisplay()

Constructors
Constructor and Description
`ReportDisplay()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Long`	`getCustomBarGraphXMLId()` Get the id that specifes a custom xml file for the bar graph.
`java.lang.Integer`	`getCustomChartHeight()`
`java.lang.Integer`	`getCustomChartWidth()`
`java.lang.Long`	`getCustomLineGraphXMLId()` Get the id that specifes a custom xml file for the line graph.
`java.lang.Long`	`getCustomPieGraphXMLId()` Get the id that specifes a custom xml file for the pie graph.
`java.lang.String`	`getCustomToolbar()` Get the path to the custom toolbar.
`java.lang.String`	`getDescription()` Get the description of this report.
`boolean`	`getDisplayThresholds()` Determine whether to show thresholds for this report.
`int`	`getDisplayType()` Determine the display type for this report.
`java.lang.String`	`getName()` Get the name of this report.
`int`	`getQuickFilterDisplay()` Determine how quick filters are displayed.
`boolean`	`getShowLegend()`
`boolean`	`getShowQuickFiltersInToolbar()` Determine whether to show quick filters in the toolbar.
`int[]`	`getSupportedTypes()` Get the display types that are supported for this report.
`java.lang.Integer`	`getThresholdColumnLocalId()` Get the local id of the column to which thresholds are being applied.
`java.lang.String`	`getThresholdColumnName()` Get the name to be displayed for the column containing the actual thresholds.
`Threshold[]`	`getThresholds()` Get the thresholds for this report.
`boolean`	`getUseDefaultBarGraphXML()` Determine whether to use default bar graph xml.
`boolean`	`getUseDefaultLineGraphXML()` Determine whether to use default line graph xml.
`boolean`	`getUseDefaultPieGraphXML()` Determine whether to use default pie graph xml.
`boolean`	`isUseCustomToolbar()` Determine whether to display a custom toolbar for this report.
`void`	`setCustomBarGraphXMLId(java.lang.Long customBarGraphXMLId_)` Set the id that specifes a custom xml file for the bar graph.
`void`	`setCustomChartHeight(java.lang.Integer customChartHeight)`
`void`	`setCustomChartWidth(java.lang.Integer customChartWidth)`
`void`	`setCustomLineGraphXMLId(java.lang.Long customLineGraphXMLId)` Set the id that specifes a custom xml file for the line graph.
`void`	`setCustomPieGraphXMLId(java.lang.Long customPieGraphXMLId_)` Set the id that specifes a custom xml file for the pie graph.
`void`	`setCustomToolbar(java.lang.String customToolbar_)` Set the path to the custom toolbar.
`void`	`setDescription(java.lang.String description_)` Set the description of this report.
`void`	`setDisplayThresholds(boolean displayThresholds_)` Set whether to show thresholds for this report.
`void`	`setDisplayType(int displayType_)` Set the display type for this report.
`void`	`setName(java.lang.String name_)` Set the name of this report.
`void`	`setQuickFilterDisplay(int quickFilterDisplay_)` Specify how quick filters should be displayed.
`void`	`setShowLegend(boolean showLegend)`
`void`	`setShowQuickFiltersInToolbar(boolean showQuickFiltersInToolbar_)` Set whether to show quick filters in the toolbar.
`void`	`setSupportedTypes(int[] supportedTypes_)` Set the display types that are supported for this report.
`void`	`setThresholdColumnLocalId(java.lang.Integer thresholdColumnLocalId_)` Set the local id of the column to which thresholds should be being applied.
`void`	`setThresholdColumnName(java.lang.String thresholdColumnName_)` Set the name to be displayed for the column containing the actual thresholds.
`void`	`setThresholds(Threshold[] thresholds_)` Set the thresholds for this report.
`void`	`setUseCustomToolbar(boolean useCustomToolbar_)` Set whether to display a custom toolbar for this report.
`void`	`setUseDefaultBarGraphXML(boolean useDefaultBarGraphXML_)` Specify whether to use default bar graph xml.
`void`	`setUseDefaultLineGraphXML(boolean useDefaultLineGraphXML)` Set whether to use default line graph xml.
`void`	`setUseDefaultPieGraphXML(boolean useDefaultPieGraphXML_)` Set whether to use default pie graph xml.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - QUICK_FILTER_LINK
```
public static final int QUICK_FILTER_LINK
```
    Display quick filters as links.
    
    See Also:
    
    Constant Field Values
  - QUICK_FILTER_DROPDOWN
```
public static final int QUICK_FILTER_DROPDOWN
```
    Display quick filters as dropdowns.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_GRID_TABLE
```
public static final int DISPLAY_GRID_TABLE
```
    Display the report at a table.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_BAR_CHART
```
public static final int DISPLAY_BAR_CHART
```
    Display the report as a bar chart.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_PIE_CHART
```
public static final int DISPLAY_PIE_CHART
```
    Display the report as a pie chart.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_STACKED_CHART
```
public static final int DISPLAY_STACKED_CHART
```
    Display the report as a stacked bar chart.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_LINE_CHART
```
public static final int DISPLAY_LINE_CHART
```
    Display the report as a line chart.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_HORIZONTAL_BAR_CHART
```
public static final int DISPLAY_HORIZONTAL_BAR_CHART
```
    Display the report as a horizontal bar chart.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_HORIZONTAL_STACKED_CHART
```
public static final int DISPLAY_HORIZONTAL_STACKED_CHART
```
    Display the report as a horizontal stacked chart.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_GANTT_CHART
```
public static final int DISPLAY_GANTT_CHART
```
    Display the report as a Gantt chart.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReportDisplay
```
public ReportDisplay()
```
- Method Detail
  - getDescription
```
public java.lang.String getDescription()
```
    Get the description of this report.
    
    Returns:
    
    the description.
    
    See Also:
    
    setDescription(java.lang.String)
  - setDescription
```
public void setDescription(java.lang.String description_)
```
    Set the description of this report.
    
    Parameters:
    
    description_ - the description.
    
    See Also:
    
    getDescription()
  - getDisplayThresholds
```
public boolean getDisplayThresholds()
```
    Determine whether to show thresholds for this report.
    
    Returns:
    
    true to display thresholds; false otherwise.
    
    See Also:
    
    setDisplayThresholds(boolean)
  - setDisplayThresholds
```
public void setDisplayThresholds(boolean displayThresholds_)
```
    Set whether to show thresholds for this report.
    
    Parameters:
    
    displayThresholds_ - true to display thresholds; false otherwise.
    
    See Also:
    
    getDisplayThresholds()
  - getDisplayType
```
public int getDisplayType()
```
    Determine the display type for this report. See the DISPLAY_XXX constants on this class.
    
    Returns:
    
    the display type.
    
    See Also:
    
    setDisplayType(int)
  - setDisplayType
```
public void setDisplayType(int displayType_)
```
    Set the display type for this report. See the DISPLAY_XXX constants on this class.
    
    Parameters:
    
    displayType_ - the display type.
    
    See Also:
    
    getDisplayType()
  - getName
```
public java.lang.String getName()
```
    Get the name of this report.
    
    Returns:
    
    the name.
    
    See Also:
    
    setName(java.lang.String)
  - setName
```
public void setName(java.lang.String name_)
```
    Set the name of this report.
    
    Parameters:
    
    name_ - the name.
    
    See Also:
    
    getName()
  - getQuickFilterDisplay
```
public int getQuickFilterDisplay()
```
    Determine how quick filters are displayed. See QUICK_FILTER_XXX constants on this class.
    
    Returns:
    
    an int specifying how the quick filters should be displayed.
    
    See Also:
    
    setQuickFilterDisplay(int)
  - setQuickFilterDisplay
```
public void setQuickFilterDisplay(int quickFilterDisplay_)
```
    Specify how quick filters should be displayed. See QUICK_FILTER_XXX constants on this class.
    
    Parameters:
    
    quickFilterDisplay_ - an int specifying how the quick filters should be displayed
    
    See Also:
    
    getQuickFilterDisplay()
  - getSupportedTypes
```
public int[] getSupportedTypes()
```
    Get the display types that are supported for this report. See the DISPLAY_XXX constants on this class.
    
    Returns:
    
    the display types.
    
    See Also:
    
    setSupportedTypes(int[])
  - setSupportedTypes
```
public void setSupportedTypes(int[] supportedTypes_)
```
    Set the display types that are supported for this report. See the DISPLAY_XXX constants on this class.
    
    Parameters:
    
    supportedTypes_ - the display types.
    
    See Also:
    
    getSupportedTypes()
  - getThresholds
```
public Threshold[] getThresholds()
```
    Get the thresholds for this report.
    
    Returns:
    
    the thresholds.
    
    See Also:
    
    setThresholds(com.appiancorp.suiteapi.process.analytics2.Threshold[])
  - setThresholds
```
public void setThresholds(Threshold[] thresholds_)
```
    Set the thresholds for this report.
    
    Parameters:
    
    thresholds_ - the thresholds.
    
    See Also:
    
    getThresholds()
  - getThresholdColumnLocalId
```
public java.lang.Integer getThresholdColumnLocalId()
```
    Get the local id of the column to which thresholds are being applied.
    
    Returns:
    
    the column's local id.
    
    See Also:
    
    setThresholdColumnLocalId(java.lang.Integer)
  - setThresholdColumnLocalId
```
public void setThresholdColumnLocalId(java.lang.Integer thresholdColumnLocalId_)
```
    Set the local id of the column to which thresholds should be being applied.
    
    Parameters:
    
    thresholdColumnLocalId_ - the column's local id.
    
    See Also:
    
    getThresholdColumnLocalId()
  - getThresholdColumnName
```
public java.lang.String getThresholdColumnName()
```
    Get the name to be displayed for the column containing the actual thresholds.
    
    Returns:
    
    the name.
    
    See Also:
    
    setThresholdColumnName(java.lang.String)
  - setThresholdColumnName
```
public void setThresholdColumnName(java.lang.String thresholdColumnName_)
```
    Set the name to be displayed for the column containing the actual thresholds.
    
    Parameters:
    
    thresholdColumnName_ - the name.
    
    See Also:
    
    getThresholdColumnName()
  - getCustomBarGraphXMLId
```
public java.lang.Long getCustomBarGraphXMLId()
```
    Get the id that specifes a custom xml file for the bar graph.
    
    Returns:
    
    the id.
    
    See Also:
    
    setCustomBarGraphXMLId(java.lang.Long)
  - setCustomBarGraphXMLId
```
public void setCustomBarGraphXMLId(java.lang.Long customBarGraphXMLId_)
```
    Set the id that specifes a custom xml file for the bar graph.
    
    Parameters:
    
    customBarGraphXMLId_ - the id.
    
    See Also:
    
    getCustomBarGraphXMLId()
  - getCustomPieGraphXMLId
```
public java.lang.Long getCustomPieGraphXMLId()
```
    Get the id that specifes a custom xml file for the pie graph.
    
    Returns:
    
    the id.
    
    See Also:
    
    setCustomPieGraphXMLId(java.lang.Long)
  - setCustomPieGraphXMLId
```
public void setCustomPieGraphXMLId(java.lang.Long customPieGraphXMLId_)
```
    Set the id that specifes a custom xml file for the pie graph.
    
    Parameters:
    
    customPieGraphXMLId_ - the id.
    
    See Also:
    
    getCustomPieGraphXMLId()
  - getCustomLineGraphXMLId
```
public java.lang.Long getCustomLineGraphXMLId()
```
    Get the id that specifes a custom xml file for the line graph.
    
    See Also:
    
    setCustomLineGraphXMLId(java.lang.Long)
  - setCustomLineGraphXMLId
```
public void setCustomLineGraphXMLId(java.lang.Long customLineGraphXMLId)
```
    Set the id that specifes a custom xml file for the line graph.
    
    Parameters:
    
    customLineGraphXMLId_ - the id.
    
    See Also:
    
    getCustomLineGraphXMLId()
  - getUseDefaultBarGraphXML
```
public boolean getUseDefaultBarGraphXML()
```
    Determine whether to use default bar graph xml. Alternative is to use a custom bar graph xml.
    
    Returns:
    
    true for default bar graph xml; false otherwise.
    
    See Also:
    
    setUseDefaultBarGraphXML(boolean)
  - setUseDefaultBarGraphXML
```
public void setUseDefaultBarGraphXML(boolean useDefaultBarGraphXML_)
```
    Specify whether to use default bar graph xml. Alternative is to use a custom bar graph xml.
    
    Parameters:
    
    useDefaultBarGraphXML_ - true for default bar graph xml; false otherwise.
    
    See Also:
    
    getUseDefaultBarGraphXML()
  - getUseDefaultPieGraphXML
```
public boolean getUseDefaultPieGraphXML()
```
    Determine whether to use default pie graph xml. Alternative is to use a custom pie graph xml.
    
    Returns:
    
    true for default pie graph xml; false otherwise.
    
    See Also:
    
    setUseDefaultPieGraphXML(boolean)
  - setUseDefaultPieGraphXML
```
public void setUseDefaultPieGraphXML(boolean useDefaultPieGraphXML_)
```
    Set whether to use default pie graph xml. Alternative is to use a custom pie graph xml.
    
    Parameters:
    
    useDefaultPieGraphXML_ - true for default pie graph xml; false otherwise.
    
    See Also:
    
    getUseDefaultPieGraphXML()
  - getUseDefaultLineGraphXML
```
public boolean getUseDefaultLineGraphXML()
```
    Determine whether to use default line graph xml. Alternative is to use a custom line graph xml.
    
    Returns:
    
    true for default line graph xml; false otherwise.
    
    See Also:
    
    setUseDefaultLineGraphXML(boolean)
  - setUseDefaultLineGraphXML
```
public void setUseDefaultLineGraphXML(boolean useDefaultLineGraphXML)
```
    Set whether to use default line graph xml. Alternative is to use a custom line graph xml.
    
    Parameters:
    
    useDefaultLineGraphXML_ - true for default line graph xml; false otherwise.
    
    See Also:
    
    getUseDefaultLineGraphXML()
  - getShowQuickFiltersInToolbar
```
public boolean getShowQuickFiltersInToolbar()
```
    Determine whether to show quick filters in the toolbar.
    
    Returns:
    
    true to show quick filters in the toolbar; false otherwise.
    
    See Also:
    
    setShowQuickFiltersInToolbar(boolean)
  - setShowQuickFiltersInToolbar
```
public void setShowQuickFiltersInToolbar(boolean showQuickFiltersInToolbar_)
```
    Set whether to show quick filters in the toolbar.
    
    Parameters:
    
    showQuickFiltersInToolbar_ - true to show quick filters in the toolbar; false otherwise.
    
    See Also:
    
    getShowQuickFiltersInToolbar()
  - getCustomToolbar
```
public java.lang.String getCustomToolbar()
```
    Get the path to the custom toolbar. This path should be to a JSP and should be relative to the application's document root folder.
    
    Returns:
    
    the path to the custom toolbar.
    
    See Also:
    
    setCustomToolbar(java.lang.String)
  - setCustomToolbar
```
public void setCustomToolbar(java.lang.String customToolbar_)
```
    Set the path to the custom toolbar.
    
    Parameters:
    
    customToolbar_ - the path to the custom toolbar.
    
    See Also:
    
    getCustomToolbar()
  - isUseCustomToolbar
```
public boolean isUseCustomToolbar()
```
    Determine whether to display a custom toolbar for this report.
    
    Returns:
    
    true to use a custom toolbar; false otherwise.
  - setUseCustomToolbar
```
public void setUseCustomToolbar(boolean useCustomToolbar_)
```
    Set whether to display a custom toolbar for this report.
    
    Parameters:
    
    useCustomToolbar_ - true to use a custom toolbar; false otherwise.
  - getCustomChartHeight
```
public java.lang.Integer getCustomChartHeight()
```
  - setCustomChartHeight
```
public void setCustomChartHeight(java.lang.Integer customChartHeight)
```
  - getCustomChartWidth
```
public java.lang.Integer getCustomChartWidth()
```
  - setCustomChartWidth
```
public void setCustomChartWidth(java.lang.Integer customChartWidth)
```
  - getShowLegend
```
public boolean getShowLegend()
```
  - setShowLegend
```
public void setShowLegend(boolean showLegend)
```

Class ReportDisplay

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

QUICK_FILTER_LINK

QUICK_FILTER_DROPDOWN

DISPLAY_GRID_TABLE

DISPLAY_BAR_CHART

DISPLAY_PIE_CHART

DISPLAY_STACKED_CHART

DISPLAY_LINE_CHART

DISPLAY_HORIZONTAL_BAR_CHART

DISPLAY_HORIZONTAL_STACKED_CHART

DISPLAY_GANTT_CHART

Constructor Detail

ReportDisplay

Method Detail

getDescription

setDescription

getDisplayThresholds

setDisplayThresholds

getDisplayType

setDisplayType

getName

setName

getQuickFilterDisplay

setQuickFilterDisplay

getSupportedTypes

setSupportedTypes

getThresholds

setThresholds

getThresholdColumnLocalId

setThresholdColumnLocalId

getThresholdColumnName

setThresholdColumnName

getCustomBarGraphXMLId

setCustomBarGraphXMLId

getCustomPieGraphXMLId

setCustomPieGraphXMLId

getCustomLineGraphXMLId

setCustomLineGraphXMLId

getUseDefaultBarGraphXML

setUseDefaultBarGraphXML

getUseDefaultPieGraphXML

setUseDefaultPieGraphXML

getUseDefaultLineGraphXML

setUseDefaultLineGraphXML

getShowQuickFiltersInToolbar

setShowQuickFiltersInToolbar

getCustomToolbar

setCustomToolbar

isUseCustomToolbar

setUseCustomToolbar

getCustomChartHeight

setCustomChartHeight

getCustomChartWidth

setCustomChartWidth

getShowLegend

setShowLegend