Package com.appiancorp.suiteapi.process.analytics2

Class ReportResultPage

java.lang.Object
com.appiancorp.suiteapi.common.Result
com.appiancorp.suiteapi.common.ResultPage
com.appiancorp.suiteapi.process.analytics2.ReportResultPage
All Implemented Interfaces:
Serializable
public class ReportResultPage extends ResultPage
Contains the results of an Analytics query.
See Also:

  • Constructor Details

    • ReportResultPage

      public ReportResultPage()

  • Method Details

    • isMaximumReportTimeExceeded

      public boolean isMaximumReportTimeExceeded()
      Returns whether the report generation took more time than the configured maximum time.
      Returns:
      true if the report took more time to generate than the configured maximum time, else false.

    • setMaximumReportTimeExceeded

      public void setMaximumReportTimeExceeded(boolean maximumReportTimeExceeded_)
      Sets whether the report generation took more time than the configured maximum time.
      Parameters:
      flag - to denote whether the maximum time exceeded.

    • isTaskIdsValid

      public boolean isTaskIdsValid()
      Is the taskIds field valid? This will be true only for task reports. If false, the field should not be used.
      Returns:
      true if the taskIds field is valid, otherwise false

    • setTaskIdsValid

      public void setTaskIdsValid(boolean valid)
      Set whether the taskIds field is valid. This is set by the report generator. Call isTaskIdsValid to determine if the field should be used.
      Parameters:
      state - whether or not the taskIds field contains valid data.

    • getPerformanceMetrics

      public PerformanceMetrics getPerformanceMetrics()
      Returns the performance metrics for the generated report.
      Returns:

    • setPerformanceMetrics

      public void setPerformanceMetrics(PerformanceMetrics performanceMetrics_)
      Sets the performance metrics for the generated report
      Parameters:
      performanceMetrics_ - Performance metrics for the report.
      See Also:
      • #PerformanceMetrics

    • getTaskIds

      public Long[] getTaskIds()
      Get the task id for each row of the report. Valid only for task reports.
      Returns:
      the task ids.
      See Also:

    • setTaskIds

      public void setTaskIds(Long[] taskIds_)
      Set the task id for each row of the report. Valid only for task reports.
      Parameters:
      taskIds_ - the task ids.
      See Also:

    • getColumnTypes

      public Map getColumnTypes()
      Get the column types for this report. For keys and values, see ProcessAnalyticsService.getReportPage(com.appiancorp.suiteapi.process.analytics2.ReportData, long).
      Returns:
      the column types.
      See Also:

    • setColumnTypes

      public void setColumnTypes(Map columnTypes_)
      Set the column types for this report.
      Parameters:
      columnTypes_ - the column types.
      See Also: