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
 void close()
          Closes the data source connection.
 IConnectionInfo getConnectionInfo()
          Gets connection information about this data source, which may include the connection type and logon credentials, for example.
 java.lang.String getDescription()
          Gets the description of this data source connection.
 java.lang.String getLocation()
          Deprecated.  
 java.lang.String getName()
          Gets the connection name.
 Fields getParameters()
          Gets the stored procedure parameters.
 TableJoins getTableJoins()
          Gets the table joins that define how tbales used in the connection are linked.
 Tables getTables()
          Deprecated.  
 boolean getTablesFetched()
          Deprecated.  
 boolean isOpen()
          Tests whether this data source connection is currently open.
 void open()
          Opens the data source connection.
 void setConnectionInfo(IConnectionInfo connectionInfo)
          Sets connection information about this data source, which may include the connection type and logon credentials, for example.
 void setDescription(java.lang.String description)
          Sets the description of this data source connection.
 void setLocation(java.lang.String location)
          Deprecated.  
 void setName(java.lang.String name)
          Sets the connection name.
 void setParameters(Fields parameters)
          Sets the stored procedure parameters.
 void setTableJoins(TableJoins tableJoins)
          Sets the table joins that define how tables used in the connection are linked.
 void setTables(Tables tables)
          Deprecated.  
 void setTablesFetched(boolean tablesFetched)
          Deprecated.  
 

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()
Gets connection information about this data source, which may include the connection type and logon credentials, for example.

Returns:
an IConnectionInfo object
See Also:
IConnectionInfo

setConnectionInfo

void setConnectionInfo(IConnectionInfo connectionInfo)
Sets connection information about this data source, which may include the connection type and logon credentials, for example.

Parameters:
connectionInfo - an IConnectionInfo object
See Also:
IConnectionInfo

getDescription

java.lang.String getDescription()
Gets the description of this data source connection.

Returns:
a String description of the connnection

setDescription

void setDescription(java.lang.String description)
Sets the description of this data source connection.

Parameters:
description - a String description of the connnection

getParameters

Fields getParameters()
Gets the stored procedure parameters.

Returns:
a collection of IParameterField objects

setParameters

void setParameters(Fields parameters)
Sets the stored procedure parameters.

Parameters:
parameters - a collection of IParameterField objects

isOpen

boolean isOpen()
               throws ReportSDKExceptionBase
Tests whether this data source connection is currently open.

Returns:
true if connected to the data source, false otherwise
Throws:
ReportSDKExceptionBase

open

void open()
          throws ReportSDKExceptionBase
Opens the data source connection.

Throws:
ReportSDKExceptionBase

close

void close()
           throws ReportSDKExceptionBase
Closes the data source connection.

Throws:
ReportSDKExceptionBase

getLocation

java.lang.String getLocation()
Deprecated. 

The location of the connection (for example, a URI).

Returns:
The location of the connection as a String.

getTableJoins

TableJoins getTableJoins()
Gets the table joins that define how tbales used in the connection are linked.

Returns:
a collection of ITableJoin objects
See Also:
ITableJoin

getTables

Tables getTables()
Deprecated. 

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

Returns:
The tables as a Tables object.

getTablesFetched

boolean getTablesFetched()
Deprecated. 

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)
Deprecated. 

The location of the connection (for example, a URI).

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

setTableJoins

void setTableJoins(TableJoins tableJoins)
Sets the table joins that define how tables used in the connection are linked.

Parameters:
tableJoins - a collection of ITableJoin objects
See Also:
ITableJoin

setTables

void setTables(Tables tables)
Deprecated. 

Returns the tables that belong to the connection. Use 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)
Deprecated. 

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.