com.crystaldecisions.sdk.occa.report.data
Interface IConnection

All Superinterfaces:
IClone
All Known Implementing Classes:
Connection

public interface IConnection
extends IClone

This interface allows you to get and set information about a data source connection and the tables that belong to it.

See Also:
IDatabase.setConnections(Connections)

Method Summary
 IConnectionInfo getConnectionInfo()
          For internal use only
 java.lang.String getDescription()
          For internal use only
 java.lang.String getLocation()
          The location of the connection (for example, a URI).
 java.lang.String getName()
          Gets the connection name.
 NavigationHierarchyNodes getNavigationHierarchyNodes()
          For internal use only
 Fields getParameters()
          For internal use only
 TableLinks getTableLinks()
          Returns the links between the tables that belong to the connection.
 Tables getTables()
          Returns the tables that belong to the connection.
 boolean getTablesFetched()
          Returns whether the tables that belong to the connection have been fetched from the server.
 void setConnectionInfo(IConnectionInfo connectionInfo)
          For internal use only
 void setDescription(java.lang.String description)
          For internal use only
 void setLocation(java.lang.String location)
          The location of the connection (for example, a URI).
 void setName(java.lang.String name)
          Sets the connection name.
 void setNavigationHierarchyNodes(NavigationHierarchyNodes navigationHierarchyNodes)
          For internal use only
 void setParameters(Fields parameters)
          For internal use only
 void setTableLinks(TableLinks tableLinks)
          Sets the links between the tables that belong to the connection.
 void setTables(Tables tables)
          Returns the tables that belong to the connection.
 void setTablesFetched(boolean tablesFetched)
          Sets whether the tables that belong to the connection have been fetched from the server.
 

Method Detail

getName

java.lang.String getName()
Gets the connection name.

Returns:
the name of this data source connection

setName

void setName(java.lang.String name)
Sets the connection name.

Parameters:
name - the name for the data source connection

getConnectionInfo

IConnectionInfo getConnectionInfo()
For internal use only


setConnectionInfo

void setConnectionInfo(IConnectionInfo connectionInfo)
For internal use only


getDescription

java.lang.String getDescription()
For internal use only


setDescription

void setDescription(java.lang.String description)
For internal use only


getParameters

Fields getParameters()
For internal use only


setParameters

void setParameters(Fields parameters)
For internal use only


getLocation

java.lang.String getLocation()
The location of the connection (for example, a URI).

Returns:
The location of the connection as a String.

getTableLinks

TableLinks getTableLinks()

Returns the links between the tables that belong to the connection. Use IConnection.getTablesFetched() to see if these tables and TableLinks have been fetched from the server.

Returns:
The table links as a TableLinks object.
See Also:
ITableLink

getTables

Tables getTables()
Returns the tables that belong to the connection. Use IConnection.getTablesFetched() to see if these tables and TableLinks have been fetched from the server.

Returns:
The tables as a Tables object.

getTablesFetched

boolean getTablesFetched()
Returns whether the tables that belong to the connection have been fetched from the server.

Returns:
true if the tables that belong to the connection have been fetched from the server, and false otherwise.

setLocation

void setLocation(java.lang.String location)
The location of the connection (for example, a URI).

Parameters:
location - The location of the connection as a String.

setTableLinks

void setTableLinks(TableLinks tableLinks)

Sets the links between the tables that belong to the connection. Use IConnection.getTablesFetched() to see if these tables and TableLinks have been fetched from the server.

Parameters:
tableLinks - The table links as a TableLinks object.
See Also:
ITableLink

setTables

void setTables(Tables tables)
Returns the tables that belong to the connection. Use IConnection.getTablesFetched() to see if these tables and TableLinks have been fetched from the server.

Parameters:
tables - The tables as a Table object.

setTablesFetched

void setTablesFetched(boolean tablesFetched)
Sets whether the tables that belong to the connection have been fetched from the server.

Parameters:
tablesFetched - true if the tables that belong to the connection have been fetched from the server, and false otherwise.

getNavigationHierarchyNodes

NavigationHierarchyNodes getNavigationHierarchyNodes()
For internal use only


setNavigationHierarchyNodes

void setNavigationHierarchyNodes(NavigationHierarchyNodes navigationHierarchyNodes)
For internal use only