|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IConnection
This interface allows you to get and set information about a data source connection and the tables that belong to it.
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 |
---|
java.lang.String getName()
void setName(java.lang.String name)
name
- the name for the data source connectionIConnectionInfo getConnectionInfo()
IConnectionInfo
objectIConnectionInfo
void setConnectionInfo(IConnectionInfo connectionInfo)
connectionInfo
- an IConnectionInfo
objectIConnectionInfo
java.lang.String getDescription()
String
description of the connnectionvoid setDescription(java.lang.String description)
description
- a String
description of the connnectionFields getParameters()
IParameterField
objectsvoid setParameters(Fields parameters)
parameters
- a collection of IParameterField
objectsboolean isOpen() throws ReportSDKExceptionBase
true
if connected to the data source, false
otherwise
ReportSDKExceptionBase
void open() throws ReportSDKExceptionBase
ReportSDKExceptionBase
void close() throws ReportSDKExceptionBase
ReportSDKExceptionBase
java.lang.String getLocation()
String
.TableJoins getTableJoins()
ITableJoin
objectsITableJoin
Tables getTables()
getTablesFetched()
to see if
these tables and TableLinks have been fetched from the server.
Tables
object.boolean getTablesFetched()
true
if the tables that belong to the connection have been fetched
from the server, and false
otherwise.void setLocation(java.lang.String location)
location
- The location of the connection as a String
.void setTableJoins(TableJoins tableJoins)
tableJoins
- a collection of ITableJoin
objectsITableJoin
void setTables(Tables tables)
getTablesFetched()
to see if
these tables and TableLinks have been fetched from the server.
tables
- The tables as a Table
object.void setTablesFetched(boolean tablesFetched)
tablesFetched
- true
if the tables that belong to the connection have been
fetched from the server, and false
otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |