ro.sync.exml.workspace.api.options
Interface DataSourceAccess

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface DataSourceAccess

Provides methods used to obtain data source connection related information.

Since:

14.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Method Summary

java.util.List<DataSourceConnectionInfo>	getAvailableDataSourceConnectionInfos() Obtain information about all the available data source connections.
DataSourceConnectionInfo	getDataSourceConnectionInfo(java.lang.String connectionName) Obtain information about the data source connection identified by the connection name.

Method Detail

getDataSourceConnectionInfo

DataSourceConnectionInfo getDataSourceConnectionInfo(java.lang.String connectionName)

Obtain information about the data source connection identified by the connection name.

Parameters:

connectionName - The name of the data source connection.

Returns:

A DataSourceConnectionInfo object capable of providing property values for a data source connection. It can return null if a connection with the given name couldn't be found.

getAvailableDataSourceConnectionInfos

java.util.List<DataSourceConnectionInfo> getAvailableDataSourceConnectionInfos()

Obtain information about all the available data source connections.

Returns:

A list with DataSourceConnectionInfo corresponding to each data source connection. If no connection is available it returns an empty list.