Class ReportData
java.lang.Object
com.appiancorp.suiteapi.process.analytics2.ReportData
- All Implemented Interfaces:
JSONable
,JSONCacheable
,Serializable
Bean defining the type of data contained in an analytics report. Does not contain
the actual data. By default, sortOrder is set to
Constants.SORT_ORDER_ASCENDING
, batchSize is set to DEFAULT_BATCH_SIZE,
sortColumnLocalId and startIndex are set to 0, and the report is not recursive.- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Report only contains data for tasks assigned to the groups specified in the context.static final int
Report only contains data for tasks attributed to the users specified in the context.static final int
Report only contains data for process models created by the users specified in the context.static final int
Report only contains data for tasks attributed to the groups specified in the context.static final int
Report only contains data for processes initiated by the users specified in the context.static final int
Report only contains data for process models last modified by the users specified in the context.static final int
Report only contains data for nodes specified in the context.static final int
Report only contains data for processes specified in the context.static final int
Report only contains data for process models specified in the context.static final int
Report only contains data for process model versions specified in the context.static final int
Report has no context.static final int
Report only contains data for tasks owned by the users specified in the context.static final int
Default number of results to return per page in the report.static final int
Deprecated.this has not been considered a valid report type and will be removedstatic final int
Deprecated.this has not been considered a valid report type and will be removedstatic final int
Report on Process Models.static final int
Report on Process Model Versions.static final int
Report on Processes.static final int
Report on Tasks.Fields inherited from interface com.appiancorp.suiteapi.common.JSONable
hiddenAttributes$TRANSIENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Add a filter to the list of base filters for this report.int
filter
(QuickFilter filter) Add a filter to the list of quick filters for this report.Filter[]
Get the list of base filters for this report.int
Get the batch size.Get a column in this report by id.Get a column in this report by stringId.Column[]
Get the columns for this report.Get the context for this report.int
Get the context type, defined by CONTEXT_TYPE_XXX.Column[]
getDateTimeColumns
(Map columnTypes_) Unused but reserved.Column[]
getMetricColumns
(Map columnTypes_) Gets the columns which can be used as metrics.Returns the next available column id.Get the list of quick filters for this report.boolean
Get whether or not to return data from recursive processes.Column[]
Gets the columns that would be shown in a report (ie. those for which getShow() returns true).Get the localId of the column to sort by for this report.Get whether to sort in ascending or descending order, defined by com.appiancorp.suiteapi.common.Constants.SORT_ORDER_XXX.int
Get the start index.int
getType()
Get the report type, defined by REPORT_TYPE_XXX.boolean
Indicates whether or not this ReportData contains any column marked as group bystatic boolean
isValidContext
(int reportType_, int contextType_) Verifies whether a context type is valid for the report type.void
setArfDocumentId
(Long arfDocumentId_) void
setBaseFilters
(Filter[] baseFilters_) Set the list of base filters for this report.void
setBatchSize
(int batchSize_) Set the batch size.void
setColumns
(Column[] columns_) Set the columns for this report.void
setContext
(LocalObject[] context_) Set the context for this report.void
setContextType
(int contextType_) Set the context type, defined by CONTEXT_TYPE_XXX.void
setQuickFilters
(QuickFilter[] quickFilters_) Set the list of quick filters for this report.void
setRecursive
(boolean recursive_) Set whether or not to return data from recursive processes.void
setReportName
(String reportName_) void
setSortColumnLocalId
(Integer sortColumnLocalId_) Set the localId of the column to sort by for this report.void
setSortOrder
(Integer sortOrder_) Set whether to sort in ascending or descending order, defined by com.appiancorp.suiteapi.common.Constants.SORT_ORDER_XXX.void
setStartIndex
(int startIndex_) Set the start index.void
setType
(int type_) Set the report type, defined by REPORT_TYPE_XXX.toString()
-
Field Details
-
REPORT_TYPE_PM
public static final int REPORT_TYPE_PMReport on Process Models.- See Also:
-
REPORT_TYPE_PROCESS
public static final int REPORT_TYPE_PROCESSReport on Processes.- See Also:
-
REPORT_TYPE_TASK
public static final int REPORT_TYPE_TASKReport on Tasks.- See Also:
-
REPORT_TYPE_PMVERSION
public static final int REPORT_TYPE_PMVERSIONReport on Process Model Versions.- See Also:
-
REPORT_TYPE_EVENTS
Deprecated.this has not been considered a valid report type and will be removedReport on Events.- See Also:
-
REPORT_TYPE_ARCHIVED_PROCESS
Deprecated.this has not been considered a valid report type and will be removedReport on Archived Processes.- See Also:
-
CONTEXT_TYPE_SYSTEM
public static final int CONTEXT_TYPE_SYSTEMReport has no context.- See Also:
-
CONTEXT_TYPE_PROCESS_MODEL
public static final int CONTEXT_TYPE_PROCESS_MODELReport only contains data for process models specified in the context.- See Also:
-
CONTEXT_TYPE_PROCESS_MODEL_VERSION
public static final int CONTEXT_TYPE_PROCESS_MODEL_VERSIONReport only contains data for process model versions specified in the context.- See Also:
-
CONTEXT_TYPE_NODE
public static final int CONTEXT_TYPE_NODEReport only contains data for nodes specified in the context.- See Also:
-
CONTEXT_TYPE_PROCESS
public static final int CONTEXT_TYPE_PROCESSReport only contains data for processes specified in the context.- See Also:
-
CONTEXT_TYPE_CREATED_BY
public static final int CONTEXT_TYPE_CREATED_BYReport only contains data for process models created by the users specified in the context.- See Also:
-
CONTEXT_TYPE_LAST_MOD_BY
public static final int CONTEXT_TYPE_LAST_MOD_BYReport only contains data for process models last modified by the users specified in the context.- See Also:
-
CONTEXT_TYPE_INITIATED_BY
public static final int CONTEXT_TYPE_INITIATED_BYReport only contains data for processes initiated by the users specified in the context.- See Also:
-
CONTEXT_TYPE_ATTRIBUTED_TO_USER
public static final int CONTEXT_TYPE_ATTRIBUTED_TO_USERReport only contains data for tasks attributed to the users specified in the context.- See Also:
-
CONTEXT_TYPE_ASSIGNED_GROUP
public static final int CONTEXT_TYPE_ASSIGNED_GROUPReport only contains data for tasks assigned to the groups specified in the context.- See Also:
-
CONTEXT_TYPE_TASK_OWNER
public static final int CONTEXT_TYPE_TASK_OWNERReport only contains data for tasks owned by the users specified in the context.- See Also:
-
CONTEXT_TYPE_GROUP_MEMBERS
public static final int CONTEXT_TYPE_GROUP_MEMBERSReport only contains data for tasks attributed to the groups specified in the context.- See Also:
-
DEFAULT_BATCH_SIZE
public static final int DEFAULT_BATCH_SIZEDefault number of results to return per page in the report.- See Also:
-
-
Constructor Details
-
ReportData
public ReportData()
-
-
Method Details
-
getArfDocumentId
-
setArfDocumentId
-
getReportName
-
setReportName
-
isValidContext
public static boolean isValidContext(int reportType_, int contextType_) Verifies whether a context type is valid for the report type.- Parameters:
reportType_
- one of the constants REPORT_TYPE_XXXcontextType_
- one of the constants CONTEXT_TYPE_XXX- Returns:
true
if the context type is valid for the report type;
-
getBaseFilters
Get the list of base filters for this report. Base filters are the default filters for the report.- Returns:
- the array of base filters
- See Also:
-
setBaseFilters
Set the list of base filters for this report. Base filters are the default filters for the report.- Parameters:
baseFilters_
- an array of base filters- See Also:
-
filter
Add a filter to the list of base filters for this report.- Parameters:
filter
-- Returns:
- filter count before adding filter
-
filter
Add a filter to the list of quick filters for this report.- Parameters:
filter
-- Returns:
- filter count before adding filter
-
getColumns
Get the columns for this report.- Returns:
- the columns
- See Also:
-
setColumns
Set the columns for this report. Note: The provided array reference is not preserved.- Parameters:
columns_
- the columns- See Also:
-
getContext
Get the context for this report.- Returns:
- the context
- See Also:
-
setContext
Set the context for this report.- Parameters:
context_
- the context- See Also:
-
getQuickFilters
Get the list of quick filters for this report.- Returns:
- the array or quick filters
- See Also:
-
setQuickFilters
Set the list of quick filters for this report.- Parameters:
quickFilters_
- the array of quick filters- See Also:
-
getSortColumnLocalId
Get the localId of the column to sort by for this report.- Returns:
- the localId of the column to sort by
- See Also:
-
setSortColumnLocalId
Set the localId of the column to sort by for this report.- Parameters:
sortColumnLocalId_
- the localId of the column to sort by- See Also:
-
getSortOrder
Get whether to sort in ascending or descending order, defined by com.appiancorp.suiteapi.common.Constants.SORT_ORDER_XXX.- Returns:
- the sort order
- See Also:
-
setSortOrder
Set whether to sort in ascending or descending order, defined by com.appiancorp.suiteapi.common.Constants.SORT_ORDER_XXX.- Parameters:
sortOrder_
- the sort order- See Also:
-
getType
public int getType()Get the report type, defined by REPORT_TYPE_XXX.- Returns:
- the report type
- See Also:
-
setType
public void setType(int type_) Set the report type, defined by REPORT_TYPE_XXX.- Parameters:
type_
- the report type- See Also:
-
getContextType
public int getContextType()Get the context type, defined by CONTEXT_TYPE_XXX.- Returns:
- the context type
- See Also:
-
setContextType
public void setContextType(int contextType_) Set the context type, defined by CONTEXT_TYPE_XXX.- Parameters:
contextType_
- the context type- See Also:
-
getColumnByLocalId
Get a column in this report by id.- Parameters:
id
- the localId of the column- Returns:
- the column
-
getColumnByStringId
Get a column in this report by stringId.- Parameters:
id
- the localId of the column- Returns:
- the column
-
getBatchSize
public int getBatchSize()Get the batch size.- Returns:
- the batch size
- See Also:
-
setBatchSize
public void setBatchSize(int batchSize_) Set the batch size.- Parameters:
batchSize_
- the batch size- See Also:
-
getStartIndex
public int getStartIndex()Get the start index.- Returns:
- the start index
- See Also:
-
setStartIndex
public void setStartIndex(int startIndex_) Set the start index.- Parameters:
startIndex_
- the start index- See Also:
-
getMetricColumns
Gets the columns which can be used as metrics. This is any displayed column with type TypedVariable.LONG, TypedVariable.DOUBLE, or TypedVariable.DURATION- Parameters:
columnTypes_
- a map of column ids to column types- Returns:
- an array of columns
-
getDateTimeColumns
-
getShownColumns
Gets the columns that would be shown in a report (ie. those for which getShow() returns true).- Returns:
- the columns that would be shown in a report
-
getHiddenAttributes
Unused but reserved.- Specified by:
getHiddenAttributes
in interfaceJSONable
- Returns:
- the set of hidden attributes
-
getRecursive
public boolean getRecursive()Get whether or not to return data from recursive processes. Only relevant when the context is a process.- Returns:
true
if recursive data is returned- See Also:
-
setRecursive
public void setRecursive(boolean recursive_) Set whether or not to return data from recursive processes. Only relevant when the context is a process.- Parameters:
recursive_
- set totrue
to return recursive data- See Also:
-
getNextAvailableColumnLocalId
Returns the next available column id.- Returns:
- the next column id
-
hasGrouping
public boolean hasGrouping()Indicates whether or not this ReportData contains any column marked as group by- Returns:
true
if any column is marked as group by.
-
toString
-