Class ReportDisplay
java.lang.Object
com.appiancorp.suiteapi.process.analytics2.ReportDisplay
- All Implemented Interfaces:
Serializable
Bean detailing how an analytics report is to be displayed.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Display the report as a bar chart.static final int
Display the report as a Gantt chart.static final int
Display the report at a table.static final int
Display the report as a horizontal bar chart.static final int
Display the report as a horizontal stacked chart.static final int
Display the report as a line chart.static final int
Display the report as a pie chart.static final int
Display the report as a stacked bar chart.static final int
Display quick filters as dropdowns.static final int
Display quick filters as links. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the id that specifes a custom xml file for the bar graph.Get the id that specifes a custom xml file for the line graph.Get the id that specifes a custom xml file for the pie graph.Get the path to the custom toolbar.Get the description of this report.boolean
Determine whether to show thresholds for this report.int
Determine the display type for this report.getName()
Get the name of this report.int
Determine how quick filters are displayed.boolean
boolean
Determine whether to show quick filters in the toolbar.int[]
Get the display types that are supported for this report.Get the local id of the column to which thresholds are being applied.Get the name to be displayed for the column containing the actual thresholds.Get the thresholds for this report.boolean
Determine whether to use default bar graph xml.boolean
Determine whether to use default line graph xml.boolean
Determine whether to use default pie graph xml.boolean
Determine whether to display a custom toolbar for this report.void
setCustomBarGraphXMLId
(Long customBarGraphXMLId_) Set the id that specifes a custom xml file for the bar graph.void
setCustomChartHeight
(Integer customChartHeight) void
setCustomChartWidth
(Integer customChartWidth) void
setCustomLineGraphXMLId
(Long customLineGraphXMLId) Set the id that specifes a custom xml file for the line graph.void
setCustomPieGraphXMLId
(Long customPieGraphXMLId_) Set the id that specifes a custom xml file for the pie graph.void
setCustomToolbar
(String customToolbar_) Set the path to the custom toolbar.void
setDescription
(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
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
(Integer thresholdColumnLocalId_) Set the local id of the column to which thresholds should be being applied.void
setThresholdColumnName
(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.
-
Field Details
-
QUICK_FILTER_LINK
public static final int QUICK_FILTER_LINKDisplay quick filters as links.- See Also:
-
QUICK_FILTER_DROPDOWN
public static final int QUICK_FILTER_DROPDOWNDisplay quick filters as dropdowns.- See Also:
-
DISPLAY_GRID_TABLE
public static final int DISPLAY_GRID_TABLEDisplay the report at a table.- See Also:
-
DISPLAY_BAR_CHART
public static final int DISPLAY_BAR_CHARTDisplay the report as a bar chart.- See Also:
-
DISPLAY_PIE_CHART
public static final int DISPLAY_PIE_CHARTDisplay the report as a pie chart.- See Also:
-
DISPLAY_STACKED_CHART
public static final int DISPLAY_STACKED_CHARTDisplay the report as a stacked bar chart.- See Also:
-
DISPLAY_LINE_CHART
public static final int DISPLAY_LINE_CHARTDisplay the report as a line chart.- See Also:
-
DISPLAY_HORIZONTAL_BAR_CHART
public static final int DISPLAY_HORIZONTAL_BAR_CHARTDisplay the report as a horizontal bar chart.- See Also:
-
DISPLAY_HORIZONTAL_STACKED_CHART
public static final int DISPLAY_HORIZONTAL_STACKED_CHARTDisplay the report as a horizontal stacked chart.- See Also:
-
DISPLAY_GANTT_CHART
public static final int DISPLAY_GANTT_CHARTDisplay the report as a Gantt chart.- See Also:
-
-
Constructor Details
-
ReportDisplay
public ReportDisplay()
-
-
Method Details
-
getDescription
Get the description of this report.- Returns:
- the description.
- See Also:
-
setDescription
Set the description of this report.- Parameters:
description_
- the description.- See Also:
-
getDisplayThresholds
public boolean getDisplayThresholds()Determine whether to show thresholds for this report.- Returns:
true
to display thresholds;false
otherwise.- See Also:
-
setDisplayThresholds
public void setDisplayThresholds(boolean displayThresholds_) Set whether to show thresholds for this report.- Parameters:
displayThresholds_
-true
to display thresholds;false
otherwise.- See Also:
-
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
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:
-
getName
Get the name of this report.- Returns:
- the name.
- See Also:
-
setName
Set the name of this report.- Parameters:
name_
- the name.- See Also:
-
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
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:
-
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
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:
-
getThresholds
Get the thresholds for this report.- Returns:
- the thresholds.
- See Also:
-
setThresholds
Set the thresholds for this report.- Parameters:
thresholds_
- the thresholds.- See Also:
-
getThresholdColumnLocalId
Get the local id of the column to which thresholds are being applied.- Returns:
- the column's local id.
- See Also:
-
setThresholdColumnLocalId
Set the local id of the column to which thresholds should be being applied.- Parameters:
thresholdColumnLocalId_
- the column's local id.- See Also:
-
getThresholdColumnName
Get the name to be displayed for the column containing the actual thresholds.- Returns:
- the name.
- See Also:
-
setThresholdColumnName
Set the name to be displayed for the column containing the actual thresholds.- Parameters:
thresholdColumnName_
- the name.- See Also:
-
getCustomBarGraphXMLId
Get the id that specifes a custom xml file for the bar graph.- Returns:
- the id.
- See Also:
-
setCustomBarGraphXMLId
Set the id that specifes a custom xml file for the bar graph.- Parameters:
customBarGraphXMLId_
- the id.- See Also:
-
getCustomPieGraphXMLId
Get the id that specifes a custom xml file for the pie graph.- Returns:
- the id.
- See Also:
-
setCustomPieGraphXMLId
Set the id that specifes a custom xml file for the pie graph.- Parameters:
customPieGraphXMLId_
- the id.- See Also:
-
getCustomLineGraphXMLId
Get the id that specifes a custom xml file for the line graph.- See Also:
-
setCustomLineGraphXMLId
Set the id that specifes a custom xml file for the line graph.- Parameters:
customLineGraphXMLId_
- the id.- See Also:
-
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
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:
-
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
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:
-
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
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:
-
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
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:
-
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
Set the path to the custom toolbar.- Parameters:
customToolbar_
- the path to the custom toolbar.- See Also:
-
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
-
setCustomChartHeight
-
getCustomChartWidth
-
setCustomChartWidth
-
getShowLegend
public boolean getShowLegend() -
setShowLegend
public void setShowLegend(boolean showLegend)
-