Package com.appiancorp.suiteapi.process.analytics2

Class ProcessReport

java.lang.Object
com.appiancorp.suiteapi.process.analytics2.ProcessReport
All Implemented Interfaces:
Serializable, Cloneable
public class ProcessReport extends Object implements Cloneable, 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:

  • Field Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

  • Constructor Details

    • ProcessReport

      public ProcessReport()

  • Method Details

    • 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 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:

    • getCache

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

    • getDisplay

      public ReportDisplay getDisplay()
      Get the display format of this report.
      Returns:
      the display format.
      See Also:

    • setDisplay

      public void setDisplay(ReportDisplay display_)
      Set the display format of this report.
      Parameters:
      display_ - the display format.
      See Also:

    • getId

      public Long getId()
      Get the id of this report.
      Returns:
      the id.
      See Also:

    • setId

      public void setId(Long id_)
      Set the id of this report.
      Parameters:
      id_ - the id.
      See Also:

    • 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

      public void setView(int view_)
      Set the view type for this report.
      Parameters:
      view_ - the view type.
      See Also:

    • 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

      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:

    • 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

      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:

    • 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&gt tag.
      Returns:
      true if the link should be shown; false otherwise.
      See Also:

    • 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:

    • 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

      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:

    • getChartHeight

      public 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

      public void setChartHeight(Integer chartHeight_)
      Set the height of the chart associated with this report.
      Parameters:
      chartHeight_ - the height in pixels.
      See Also:

    • getChartWidth

      public 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

      public void setChartWidth(Integer chartWidth_)
      Set the width of the chart associated with this report.
      Parameters:
      chartWidth_ - the width in pixels.
      See Also:

    • getGraphSize

      public Integer getGraphSize()

    • setGraphSize

      public void setGraphSize(Integer graphSize_)

    • getPortletId

      public Long getPortletId()
      Get the Id of the portlet that contains the report.
      Returns:
      Id of the portlet
      See Also:

    • setPortletId

      public void setPortletId(Long portletId_)
      Sets the Id of the portlet that will contain the report.
      Parameters:
      portletId_ - Id of the portlet
      See Also:

    • 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

      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:

    • getShowFilters

      public Boolean getShowFilters()

    • setShowFilters

      public void setShowFilters(Boolean showFilters)

    • getShowUserControls

      public Boolean getShowUserControls()

    • setShowUserControls

      public void setShowUserControls(Boolean showUserControls)

    • getShowEditControls

      public Boolean getShowEditControls()

    • setShowEditControls

      public void setShowEditControls(Boolean showEditControls)

    • toString

      public String toString()
      Overrides:
      toString in class Object