org.dashbuilder.dataset.service

Interface DataSetDefServices

public interface DataSetDefServices

Services for the handling of data set definitions

Method Summary

Modifier and Type	Method and Description
org.dashbuilder.dataset.def.DataSetDef	createDataSetDef(org.dashbuilder.dataprovider.DataSetProviderType type) Creates a brand new data set definition for the provider type specified
List<org.dashbuilder.dataset.def.DataSetDef>	getPublicDataSetDefs() Get those public (shareable) data set definition (those with the "public" flag set to true)
String	registerDataSetDef(org.dashbuilder.dataset.def.DataSetDef definition, String message) Register a data set definition.
void	removeDataSetDef(String uuid, String message) Removes a data set definition from the registry.

Method Detail

getPublicDataSetDefs

List<org.dashbuilder.dataset.def.DataSetDef> getPublicDataSetDefs()

Get those public (shareable) data set definition (those with the "public" flag set to true)

createDataSetDef

org.dashbuilder.dataset.def.DataSetDef createDataSetDef(org.dashbuilder.dataprovider.DataSetProviderType type)

Creates a brand new data set definition for the provider type specified

Parameters:

type - The provider type

Returns:

A data set definition instance

registerDataSetDef

String registerDataSetDef(org.dashbuilder.dataset.def.DataSetDef definition,
                          String message)

Register a data set definition.

Parameters:

definition - The data set definition.

message, - A message top store along the registration request. If null is ignored.

Returns:

The registered data set definition UUID. If UUID not present on the definition from the argument definition, the UUID will be generated.

removeDataSetDef

void removeDataSetDef(String uuid,
                      String message)

Removes a data set definition from the registry.

Parameters:

message, - A message top store along the registration request. If null is ignored.

uuid - The data set definition identifier.