Dashboard Builder Data Provider API 6.0.0.Beta3

org.jboss.dashboard.provider
Interface DataProviderManager


public interface DataProviderManager

Manager class that it allows for the retrieval of DataProvider instances.


Method Summary
 DataProvider createDataProvider()
          Factory method for the creation of a DataProvider brand new instance.
 Set getAllDataProviders()
          Get all the data providers instances created.
 DataProvider getDataProviderByCode(String code)
          Get a persistent provider by its universal code.
 DataProvider getDataProviderById(Long id)
          Get a persistent provider by its identifier.
 DataProviderType[] getDataProviderTypes()
          Get installed data providers.
 DataProviderType getProviderTypeByUid(String uid)
          Get a provider type by its UID.
 void removeDataProvider(DataProvider dataProvider)
          Remove data provider
 void sortDataPropertiesByName(List<DataProperty> propList, boolean ascending)
          Sort a list of properties by name.
 void sortDataProvidersByDescription(List<DataProvider> propList, boolean ascending)
          Sort a list of data provider by description.
 

Method Detail

getDataProviderTypes

DataProviderType[] getDataProviderTypes()
Get installed data providers.


getProviderTypeByUid

DataProviderType getProviderTypeByUid(String uid)
Get a provider type by its UID.


createDataProvider

DataProvider createDataProvider()
Factory method for the creation of a DataProvider brand new instance.


getAllDataProviders

Set getAllDataProviders()
                        throws Exception
Get all the data providers instances created.

Returns:
A set of DataProvider instances.
Throws:
Exception

getDataProviderById

DataProvider getDataProviderById(Long id)
                                 throws Exception
Get a persistent provider by its identifier.

Throws:
Exception

getDataProviderByCode

DataProvider getDataProviderByCode(String code)
                                   throws Exception
Get a persistent provider by its universal code.

Throws:
Exception

removeDataProvider

void removeDataProvider(DataProvider dataProvider)
                        throws Exception
Remove data provider

Throws:
Exception

sortDataProvidersByDescription

void sortDataProvidersByDescription(List<DataProvider> propList,
                                    boolean ascending)
Sort a list of data provider by description.


sortDataPropertiesByName

void sortDataPropertiesByName(List<DataProperty> propList,
                              boolean ascending)
Sort a list of properties by name.


Dashboard Builder Data Provider API 6.0.0.Beta3

Copyright © 2012-2013 JBoss by Red Hat. All Rights Reserved.