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
Contains the results of an Analytics query.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the column types for this report.Returns the performance metrics for the generated report.Long[]
Get the task id for each row of the report.boolean
Returns whether the report generation took more time than the configured maximum time.boolean
Is the taskIds field valid?void
setColumnTypes
(Map columnTypes_) Set the column types for this report.void
setMaximumReportTimeExceeded
(boolean maximumReportTimeExceeded_) Sets whether the report generation took more time than the configured maximum time.void
setPerformanceMetrics
(PerformanceMetrics performanceMetrics_) Sets the performance metrics for the generated reportvoid
setTaskIds
(Long[] taskIds_) Set the task id for each row of the report.void
setTaskIdsValid
(boolean valid) Set whether the taskIds field is valid.Methods inherited from class com.appiancorp.suiteapi.common.ResultPage
addResults, getAvailableItems, getCodesForFailedIds, getFailedIds, getParent, setAvailableItems, setCodesForFailedIds, setFailedIds, setParent, toString
Methods inherited from class com.appiancorp.suiteapi.common.Result
getNumResults, getResults, setResults
-
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
Returns the performance metrics for the generated report.- Returns:
-
setPerformanceMetrics
Sets the performance metrics for the generated report- Parameters:
performanceMetrics_
- Performance metrics for the report.- See Also:
-
#PerformanceMetrics
-
getTaskIds
Get the task id for each row of the report. Valid only for task reports.- Returns:
- the task ids.
- See Also:
-
setTaskIds
Set the task id for each row of the report. Valid only for task reports.- Parameters:
taskIds_
- the task ids.- See Also:
-
getColumnTypes
Get the column types for this report. For keys and values, seeProcessAnalyticsService.getReportPage(com.appiancorp.suiteapi.process.analytics2.ReportData, long)
.- Returns:
- the column types.
- See Also:
-
setColumnTypes
Set the column types for this report.- Parameters:
columnTypes_
- the column types.- See Also:
-