Class BaseDashboardComponentDefinitionModel

java.lang.Object

com.flowable.platform.engine.impl.repository.dashboard.BaseDashboardComponentDefinitionModel

All Implemented Interfaces:

DashboardComponentDefinitionModel

public class BaseDashboardComponentDefinitionModel
extends Object
implements DashboardComponentDefinitionModel

Nested Class Summary

Nested classes/interfaces inherited from interface DashboardComponentDefinitionModel

DashboardComponentDefinitionModel.DashboardComponentAggregationDefinition, DashboardComponentDefinitionModel.DashboardComponentInfo, DashboardComponentDefinitionModel.DashboardComponentInputParameter, DashboardComponentDefinitionModel.DashboardComponentOption, DashboardComponentDefinitionModel.DashboardComponentQueryModelInfo, DashboardComponentDefinitionModel.DashboardComponentQueryResultMapping

Field Summary

Fields

Modifier and Type	Field	Description
protected String	category
protected tools.jackson.databind.node.ObjectNode	configuration
protected String	description
protected List<DashboardComponentDefinitionModel.DashboardComponentInputParameter>	inputParameters
protected String	key
protected String	name
protected List<DashboardComponentDefinitionModel.DashboardComponentOption>	options
protected DashboardComponentDefinitionModel.DashboardComponentQueryModelInfo	queryModel
protected DashboardComponentDefinitionModel.DashboardComponentQueryResultMapping	queryResultMapping
protected List<String>	requiredAuthorities
protected tools.jackson.databind.JsonNode	staticData
protected String	subType
protected String	type

Constructor Summary

Constructors

Constructor	Description
BaseDashboardComponentDefinitionModel()

Method Summary

Modifier and Type	Method	Description
String	getCategory()	Returns the category of this dashboard component, e.g.
tools.jackson.databind.node.ObjectNode	getConfiguration()	A configuration that is component dependent
String	getDescription()	Returns the optional description of this dashboard component definition, describing where and how it might be used.
List<DashboardComponentDefinitionModel.DashboardComponentInputParameter>	getInputParameters()	Returns the list of input parameters that this component can use.
String	getKey()	Returns the business key usually used to reference or lookup a dashboard component definition regardless of its version.
String	getName()	Returns the name of this dashboard component definition.
List<DashboardComponentDefinitionModel.DashboardComponentOption>	getOptions()	Returns the list of potential options for this component.
DashboardComponentDefinitionModel.DashboardComponentQueryModelInfo	getQueryModel()	Returns the key of the query model that is used to fetch the data needed to display this component.
DashboardComponentDefinitionModel.DashboardComponentQueryResultMapping	getQueryResultMapping()	Returns the mapping configuration to map from the result of executing the query model to the data format.
List<String>	getRequiredAuthorities()	Returns the authorities required to access this dashboard component.
tools.jackson.databind.JsonNode	getStaticData()	Returns the static data, if any is set.
String	getSubType()	Specifies the component further and together with the type should fully classify the component.
String	getType()	Returns the high-level type of this dashboard component, for example 'line chart'.
void	setCategory(String category)
void	setConfiguration(tools.jackson.databind.node.ObjectNode configuration)
void	setDescription(String description)
void	setInputParameters(List<DashboardComponentDefinitionModel.DashboardComponentInputParameter> inputParameters)
void	setKey(String key)
void	setName(String name)
void	setOptions(List<DashboardComponentDefinitionModel.DashboardComponentOption> options)
void	setQueryModel(DashboardComponentDefinitionModel.DashboardComponentQueryModelInfo queryModel)
void	setQueryResultMapping(DashboardComponentDefinitionModel.DashboardComponentQueryResultMapping queryResultMapping)
void	setRequiredAuthorities(List<String> requiredAuthorities)
void	setStaticData(tools.jackson.databind.JsonNode staticData)
void	setSubType(String subType)
void	setType(String type)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

key

protected String key

name

protected String name

description

protected String description

type

protected String type

subType

protected String subType

category

protected String category

queryModel

protected DashboardComponentDefinitionModel.DashboardComponentQueryModelInfo queryModel

staticData

protected tools.jackson.databind.JsonNode staticData

inputParameters

protected List<DashboardComponentDefinitionModel.DashboardComponentInputParameter> inputParameters

options

protected List<DashboardComponentDefinitionModel.DashboardComponentOption> options

configuration

protected tools.jackson.databind.node.ObjectNode configuration

queryResultMapping

protected DashboardComponentDefinitionModel.DashboardComponentQueryResultMapping queryResultMapping

requiredAuthorities

protected List<String> requiredAuthorities

Constructor Details

BaseDashboardComponentDefinitionModel

public BaseDashboardComponentDefinitionModel()

Method Details

getKey

public String getKey()

Description copied from interface: DashboardComponentDefinitionModel

Returns the business key usually used to reference or lookup a dashboard component definition regardless of its version.

Specified by:

getKey in interface DashboardComponentDefinitionModel

setKey

public void setKey(String key)

getName

public String getName()

Description copied from interface: DashboardComponentDefinitionModel

Returns the name of this dashboard component definition.

Specified by:

getName in interface DashboardComponentDefinitionModel

setName

public void setName(String name)

getDescription

public String getDescription()

Description copied from interface: DashboardComponentDefinitionModel

Returns the optional description of this dashboard component definition, describing where and how it might be used.

Specified by:

getDescription in interface DashboardComponentDefinitionModel

setDescription

public void setDescription(String description)

getType

public String getType()

Description copied from interface: DashboardComponentDefinitionModel

Returns the high-level type of this dashboard component, for example 'line chart'.

Specified by:

getType in interface DashboardComponentDefinitionModel

setType

public void setType(String type)

getSubType

public String getSubType()

Description copied from interface: DashboardComponentDefinitionModel

Specifies the component further and together with the type should fully classify the component. For exampler 'processInstanceThroughput'.

Specified by:

getSubType in interface DashboardComponentDefinitionModel

setSubType

public void setSubType(String subType)

getCategory

public String getCategory()

Description copied from interface: DashboardComponentDefinitionModel

Returns the category of this dashboard component, e.g. 'agent', 'case', 'process', 'task'.

Specified by:

getCategory in interface DashboardComponentDefinitionModel

setCategory

public void setCategory(String category)

getQueryModel

public DashboardComponentDefinitionModel.DashboardComponentQueryModelInfo getQueryModel()

Description copied from interface: DashboardComponentDefinitionModel

Returns the key of the query model that is used to fetch the data needed to display this component.

Specified by:

getQueryModel in interface DashboardComponentDefinitionModel

setQueryModel

public void setQueryModel(DashboardComponentDefinitionModel.DashboardComponentQueryModelInfo queryModel)

getInputParameters

public List<DashboardComponentDefinitionModel.DashboardComponentInputParameter> getInputParameters()

Description copied from interface: DashboardComponentDefinitionModel

Returns the list of input parameters that this component can use.

Specified by:

getInputParameters in interface DashboardComponentDefinitionModel

setInputParameters

public void setInputParameters(List<DashboardComponentDefinitionModel.DashboardComponentInputParameter> inputParameters)

getOptions

public List<DashboardComponentDefinitionModel.DashboardComponentOption> getOptions()

Description copied from interface: DashboardComponentDefinitionModel

Returns the list of potential options for this component.

Specified by:

getOptions in interface DashboardComponentDefinitionModel

setOptions

public void setOptions(List<DashboardComponentDefinitionModel.DashboardComponentOption> options)

getConfiguration

public tools.jackson.databind.node.ObjectNode getConfiguration()

Description copied from interface: DashboardComponentDefinitionModel

A configuration that is component dependent

Specified by:

getConfiguration in interface DashboardComponentDefinitionModel

setConfiguration

public void setConfiguration(tools.jackson.databind.node.ObjectNode configuration)

getQueryResultMapping

public DashboardComponentDefinitionModel.DashboardComponentQueryResultMapping getQueryResultMapping()

Description copied from interface: DashboardComponentDefinitionModel

Returns the mapping configuration to map from the result of executing the query model to the data format.

Specified by:

getQueryResultMapping in interface DashboardComponentDefinitionModel

setQueryResultMapping

public void setQueryResultMapping(DashboardComponentDefinitionModel.DashboardComponentQueryResultMapping queryResultMapping)

getStaticData

public tools.jackson.databind.JsonNode getStaticData()

Description copied from interface: DashboardComponentDefinitionModel

Returns the static data, if any is set. If static data is set, no query will be executed to get real data.

Specified by:

getStaticData in interface DashboardComponentDefinitionModel

setStaticData

public void setStaticData(tools.jackson.databind.JsonNode staticData)

getRequiredAuthorities

public List<String> getRequiredAuthorities()

Description copied from interface: DashboardComponentDefinitionModel

Returns the authorities required to access this dashboard component. If the list is null or empty, no authority is required (open access). A user has access if they are an admin or have any one of the listed authorities.

Specified by:

getRequiredAuthorities in interface DashboardComponentDefinitionModel

setRequiredAuthorities

public void setRequiredAuthorities(List<String> requiredAuthorities)