ProcessReport (Appian API)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class ProcessReport
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
Bean detailing an analytics report specification. ProcessReports are serialized and saved to the file system as .arf files. Look in the Reports section of the documentation to see a template of an .arf file.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`VIEW_DEFAULT` Used to specify a default view type.
`static int`	`VIEW_GROUP` Used to specify a group view type.
`static int`	`VIEW_PRINT` Used to specify a print view type.
`static int`	`VIEW_PROCESS` Used to specify a process view type.
`static int`	`VIEW_PROCESS_INSTANCES` Used to specify a running process view In Process Modeler.
`static int`	`VIEW_TASK` Used to specify a task view type.
`static int`	`VIEW_USER` Used to specify a user view type.

Constructor Summary

Constructors
Constructor and Description

ProcessReport()

Constructors
Constructor and Description
`ProcessReport()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ProcessReport`	`clone()` Cloneable implementation - creates a deep copy the `ProcessReport`.
`ProcessReport`	`copy()` Deprecated. use `clone()` instead
`java.util.Map`	`getCache()` Get the type cache used for rendering this report.
`java.lang.Integer`	`getChartHeight()` Get the height of the chart associated with this report.
`java.lang.Integer`	`getChartWidth()` Get the width of the chart associated with this report.
`ReportData`	`getData()` Get the data for this report.
`ReportDisplay`	`getDisplay()` Get the display format of this report.
`java.lang.Integer`	`getGraphSize()`
`java.lang.Long`	`getId()` Get the id of this report.
`boolean`	`getModified()` Determine if this report has been modified.
`java.lang.Long`	`getPortletId()` Get the Id of the portlet that contains the report.
`boolean`	`getShowDisplayOptions()` Determine whether to show the show/hide columns link on the report.
`java.lang.Boolean`	`getShowEditControls()`
`java.lang.Boolean`	`getShowFilters()`
`boolean`	`getShowTitle()` Determine whether a name of the report should be displayed at the top.
`boolean`	`getShowToolbar()` Determine whether a toolbar should be displayed for this report.
`java.lang.Boolean`	`getShowUserControls()`
`int`	`getView()` Get the view type for this report.
`boolean`	`getWriteAccess()` Get whether this report can be edited and saved by the current user.
`void`	`populateAppianTypeCache(ServiceContext sc_)` Populate the Appian type cache on this report.
`void`	`setChartHeight(java.lang.Integer chartHeight_)` Set the height of the chart associated with this report.
`void`	`setChartWidth(java.lang.Integer chartWidth_)` Set the width of the chart associated with this report.
`void`	`setData(ReportData data_)` Set the data for this report.
`void`	`setDisplay(ReportDisplay display_)` Set the display format of this report.
`void`	`setGraphSize(java.lang.Integer graphSize_)`
`void`	`setId(java.lang.Long id_)` Set the id of this report.
`void`	`setModified(boolean modified_)` Set whether this report has been modified.
`void`	`setPortletId(java.lang.Long portletId_)` Sets the Id of the portlet that will contain the report.
`void`	`setShowDisplayOptions(boolean showDisplayOptions_)` Set whether the show/hide columns link will be shown on the report.
`void`	`setShowEditControls(java.lang.Boolean showEditControls)`
`void`	`setShowFilters(java.lang.Boolean showFilters)`
`void`	`setShowTitle(boolean showTitle_)` Set whether the name of the report should be displayed at the top.
`void`	`setShowToolbar(boolean showToolbar_)` Set whether a toolbar will be shown for this report.
`void`	`setShowUserControls(java.lang.Boolean showUserControls)`
`void`	`setView(int view_)` Set the view type for this report.
`void`	`setWriteAccess(boolean writeAccess_)` Set whether this report can be edited and saved by the current user.
`java.lang.String`	`toString()`

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

- Field Detail
  - VIEW_DEFAULT
```
public static final int VIEW_DEFAULT
```
    Used to specify a default view type. The default view is the normal view in reporting. It is the view that isn't one of the other specific views.
    
    See Also:
    
    Constant Field Values
  - VIEW_PROCESS
```
public static final int VIEW_PROCESS
```
    Used to specify a process view type. The process view is when a report is being seen in the process area of the user interface.
    
    See Also:
    
    Constant Field Values
  - VIEW_TASK
```
public static final int VIEW_TASK
```
    Used to specify a task view type. The task view is when a report is being seen in the task area of the user interface.
    
    See Also:
    
    Constant Field Values
  - VIEW_PRINT
```
public static final int VIEW_PRINT
```
    Used to specify a print view type. The print view is when a report is being printed.
    
    See Also:
    
    Constant Field Values
  - VIEW_USER
```
public static final int VIEW_USER
```
    Used to specify a user view type. The user view is when a report is being seen in the user's section of the people area of the user interface.
    
    See Also:
    
    Constant Field Values
  - VIEW_GROUP
```
public static final int VIEW_GROUP
```
    Used to specify a group view type. The user view is when a report is being seen in the group's section of the people area of the user interface.
    
    See Also:
    
    Constant Field Values
  - VIEW_PROCESS_INSTANCES
```
public static final int VIEW_PROCESS_INSTANCES
```
    Used to specify a running process view In Process Modeler. The running process view is when a report is being seen in the process modeler design area of the user interface.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProcessReport
```
public ProcessReport()
```
- Method Detail
  - clone
```
public ProcessReport clone()
```
    Cloneable implementation - creates a deep copy the ProcessReport. It does not make a deep or shallow copy of the type cache, rather it creates a new empty cache which could be re-populated using populateAppianTypeCache(ServiceContext).
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a copy of the process report
  - copy
```
@Deprecated
public ProcessReport copy()
```
    Deprecated. use clone() instead
  - getData
```
public ReportData getData()
```
    Get the data for this report.
    
    Returns:
    
    the data.
    
    See Also:
    
    setData(com.appiancorp.suiteapi.process.analytics2.ReportData)
  - getCache
```
public java.util.Map getCache()
```
    Get the type cache used for rendering this report. The cache stores Appian objects (e.g. report context, users used in filters, etc.) so that they do not need to be reloaded each time Report Options is opened.
    
    Returns:
    
    the type cache.
  - setData
```
public void setData(ReportData data_)
```
    Set the data for this report.
    
    Parameters:
    
    data_ - the data.
    
    See Also:
    
    getData()
  - getDisplay
```
public ReportDisplay getDisplay()
```
    Get the display format of this report.
    
    Returns:
    
    the display format.
    
    See Also:
    
    setDisplay(com.appiancorp.suiteapi.process.analytics2.ReportDisplay)
  - setDisplay
```
public void setDisplay(ReportDisplay display_)
```
    Set the display format of this report.
    
    Parameters:
    
    display_ - the display format.
    
    See Also:
    
    getDisplay()
  - getId
```
public java.lang.Long getId()
```
    Get the id of this report.
    
    Returns:
    
    the id.
    
    See Also:
    
    setId(java.lang.Long)
  - setId
```
public void setId(java.lang.Long id_)
```
    Set the id of this report.
    
    Parameters:
    
    id_ - the id.
    
    See Also:
    
    getId()
  - populateAppianTypeCache
```
public void populateAppianTypeCache(ServiceContext sc_)
```
    Populate the Appian type cache on this report.
    
    Parameters:
    
    sc_ - the service context used to query for type information.
  - getView
```
public int getView()
```
    Get the view type for this report. This information is used by the middle tier to determine how to display the report. It is not persisted in the engine. See the VIEW_XXX constants on this class. For example, for VIEW_DEFAULT, the report options dialogue is titled "Report Options", but for VIEW_TASK the dialogue is titled "Task View Options"
    
    Returns:
    
    the view type.
    
    See Also:
    
    setView(int)
  - setView
```
public void setView(int view_)
```
    Set the view type for this report.
    
    Parameters:
    
    view_ - the view type.
    
    See Also:
    
    getView()
  - getWriteAccess
```
public boolean getWriteAccess()
```
    Get whether this report can be edited and saved by the current user. This is set in AnalyticsServiceJavaImpl whenever the report is loaded and is based on the folder permissions.
    
    Returns:
    
    true if the current user can save the report; false otherwise.
    
    See Also:
    
    setWriteAccess(boolean)
  - setWriteAccess
```
public void setWriteAccess(boolean writeAccess_)
```
    Set whether this report can be edited and saved by the current user.
    
    Parameters:
    
    writeAccess_ - true if the current user can save the report; false otherwise.
    
    See Also:
    
    getWriteAccess()
  - getShowToolbar
```
public boolean getShowToolbar()
```
    Determine whether a toolbar should be displayed for this report. This is specified as a boolean attribute in the <apr:report> tag.
    
    Returns:
    
    true if a toolbar should be visible; false if not.
    
    See Also:
    
    setShowToolbar(boolean), ProcessReportTag
  - setShowToolbar
```
public void setShowToolbar(boolean showToolbar_)
```
    Set whether a toolbar will be shown for this report.
    
    Parameters:
    
    showToolbar_ - true if a toolbar should be visible; false if not.
    
    See Also:
    
    getShowToolbar()
  - getShowDisplayOptions
```
public boolean getShowDisplayOptions()
```
    Determine whether to show the show/hide columns link on the report. This is specified as a boolean attribute in the <apr:report> tag.
    
    Returns:
    
    true if the link should be shown; false otherwise.
    
    See Also:
    
    setShowDisplayOptions(boolean), ProcessReportTag
  - setShowDisplayOptions
```
public void setShowDisplayOptions(boolean showDisplayOptions_)
```
    Set whether the show/hide columns link will be shown on the report.
    
    Parameters:
    
    showDisplayOptions_ - true if the link should be shown; false otherwise.
    
    See Also:
    
    getShowDisplayOptions()
  - getModified
```
public boolean getModified()
```
    Determine if this report has been modified. This gets set to true every time you update and close the report options. It is reset to false when the report is saved.
    
    Returns:
    
    true if the report has been modified; false otherwise.
    
    See Also:
    
    setModified(boolean)
  - setModified
```
public void setModified(boolean modified_)
```
    Set whether this report has been modified.
    
    Parameters:
    
    modified_ - true if the report has been modified; false otherwise.
    
    See Also:
    
    getModified()
  - getChartHeight
```
public java.lang.Integer getChartHeight()
```
    Get the height of the chart associated with this report. When this is null, a default height is loaded by ChartDataUtil
    
    Returns:
    
    the height in pixels.
    
    See Also:
    
    setChartHeight(java.lang.Integer)
  - setChartHeight
```
public void setChartHeight(java.lang.Integer chartHeight_)
```
    Set the height of the chart associated with this report.
    
    Parameters:
    
    chartHeight_ - the height in pixels.
    
    See Also:
    
    getChartHeight()
  - getChartWidth
```
public java.lang.Integer getChartWidth()
```
    Get the width of the chart associated with this report. When this is null, a default width is loaded by ChartDataUtil
    
    Returns:
    
    the width in pixels.
    
    See Also:
    
    setChartWidth(java.lang.Integer)
  - setChartWidth
```
public void setChartWidth(java.lang.Integer chartWidth_)
```
    Set the width of the chart associated with this report.
    
    Parameters:
    
    chartWidth_ - the width in pixels.
    
    See Also:
    
    getChartWidth()
  - getGraphSize
```
public java.lang.Integer getGraphSize()
```
  - setGraphSize
```
public void setGraphSize(java.lang.Integer graphSize_)
```
  - getPortletId
```
public java.lang.Long getPortletId()
```
    Get the Id of the portlet that contains the report.
    
    Returns:
    
    Id of the portlet
    
    See Also:
    
    setPortletId(java.lang.Long)
  - setPortletId
```
public void setPortletId(java.lang.Long portletId_)
```
    Sets the Id of the portlet that will contain the report.
    
    Parameters:
    
    portletId_ - Id of the portlet
    
    See Also:
    
    getPortletId()
  - getShowTitle
```
public boolean getShowTitle()
```
    Determine whether a name of the report should be displayed at the top. This is specified as a boolean attribute in the <apr:report> tag.
    
    Returns:
    
    true if the name of the report should be visible; false if not.
    
    See Also:
    
    setShowTitle(boolean), ProcessReportTag
  - setShowTitle
```
public void setShowTitle(boolean showTitle_)
```
    Set whether the name of the report should be displayed at the top.
    
    Parameters:
    
    showTitle_ - true if the name of the report should be visible; false if not.
    
    See Also:
    
    getShowTitle()
  - getShowFilters
```
public java.lang.Boolean getShowFilters()
```
  - setShowFilters
```
public void setShowFilters(java.lang.Boolean showFilters)
```
  - getShowUserControls
```
public java.lang.Boolean getShowUserControls()
```
  - setShowUserControls
```
public void setShowUserControls(java.lang.Boolean showUserControls)
```
  - getShowEditControls
```
public java.lang.Boolean getShowEditControls()
```
  - setShowEditControls
```
public void setShowEditControls(java.lang.Boolean showEditControls)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ProcessReport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VIEW_DEFAULT

VIEW_PROCESS

VIEW_TASK

VIEW_PRINT

VIEW_USER

VIEW_GROUP

VIEW_PROCESS_INSTANCES

Constructor Detail

ProcessReport

Method Detail

clone

copy

getData

getCache

setData

getDisplay

setDisplay

getId

setId

populateAppianTypeCache

getView

setView

getWriteAccess

setWriteAccess

getShowToolbar

setShowToolbar

getShowDisplayOptions

setShowDisplayOptions

getModified

setModified

getChartHeight

setChartHeight

getChartWidth

setChartWidth

getGraphSize

setGraphSize

getPortletId

setPortletId

getShowTitle

setShowTitle

getShowFilters

setShowFilters

getShowUserControls

setShowUserControls

getShowEditControls

setShowEditControls

toString