Package com.flowable.platform.service.dashboard

Interface DashboardService

All Known Implementing Classes:

DashboardServiceImpl

public interface DashboardService

Method Summary

Modifier and Type	Method	Description
Dashboard	createDashboard(String name, String currentUserId, String currentTenantId)	Creates a new Dashboard for the given user and tenant.
DashboardQuery	createDashboardQuery()	Create a DashboardQuery which can be used to query existing dashboards.
DashboardUpdateBuilder	createDashboardUpdateBuilder(String dashboardId)	Updates the dashboard configuration
void	delete(String dashboardId)	Deletes a Dashboard.
void	exportDataAsCSV(String dashboardId, String componentDefinitionKey, com.fasterxml.jackson.databind.JsonNode inputParameterValues, com.fasterxml.jackson.databind.JsonNode optionValues, OutputStream outputStream)	Returns the data for one component of a dashboard, as CSV and written directly to the outputsteam to avoid loading it in memory.
List<DashboardComponentDefinitionModel>	getAvailableComponentDefinitions(String dashboardId)	Returns a catalogue of components (returned as a list of DashboardComponentDefinitionModels) that can be added to the Dashboard with the provided id.
List<DashboardParameterValue>	getAvailableInputParameterValues(String dashboardId, String tenantId, String type)
List<DashboardAvailableVariable>	getAvailableVariables(String dashboardId, String tenantId, String variableNameLike, com.fasterxml.jackson.databind.JsonNode inputParameters, int responseSize)
List<DashboardComponentDefinitionModel.DashboardComponentInfo>	getDashboardComponentInfo(String dashboardId)	Returns the metadata of all components for the dashboard with the provided id.
DashboardComponentData	getData(String dashboardId, String componentDefinitionKey, com.fasterxml.jackson.databind.JsonNode inputParameterValues, com.fasterxml.jackson.databind.JsonNode optionValues)	Returns the data for one component of a dashboard, using the provided input parameters and options.

Method Details

createDashboard

Dashboard createDashboard(String name,
 String currentUserId,
 String currentTenantId)

Creates a new Dashboard for the given user and tenant.

createDashboardQuery

DashboardQuery createDashboardQuery()

Create a DashboardQuery which can be used to query existing dashboards.

delete

void delete(String dashboardId)

Deletes a Dashboard.

getAvailableComponentDefinitions

List<DashboardComponentDefinitionModel> getAvailableComponentDefinitions(String dashboardId)

Returns a catalogue of components (returned as a list of DashboardComponentDefinitionModels) that can be added to the Dashboard with the provided id.

getAvailableVariables

List<DashboardAvailableVariable> getAvailableVariables(String dashboardId,
 String tenantId,
 String variableNameLike,
 com.fasterxml.jackson.databind.JsonNode inputParameters,
 int responseSize)

getAvailableInputParameterValues

List<DashboardParameterValue> getAvailableInputParameterValues(String dashboardId,
 String tenantId,
 String type)

createDashboardUpdateBuilder

DashboardUpdateBuilder createDashboardUpdateBuilder(String dashboardId)

Updates the dashboard configuration

getDashboardComponentInfo

List<DashboardComponentDefinitionModel.DashboardComponentInfo> getDashboardComponentInfo(String dashboardId)

Returns the metadata of all components for the dashboard with the provided id. The map will have the component instance id as key and the list of input parameters as value.

getData

DashboardComponentData getData(String dashboardId,
 String componentDefinitionKey,
 com.fasterxml.jackson.databind.JsonNode inputParameterValues,
 com.fasterxml.jackson.databind.JsonNode optionValues)

Returns the data for one component of a dashboard, using the provided input parameters and options.

exportDataAsCSV

void exportDataAsCSV(String dashboardId,
 String componentDefinitionKey,
 com.fasterxml.jackson.databind.JsonNode inputParameterValues,
 com.fasterxml.jackson.databind.JsonNode optionValues,
 OutputStream outputStream)

Returns the data for one component of a dashboard, as CSV and written directly to the outputsteam to avoid loading it in memory.