This interface enables you to get and set information for the data source connection.
Method Summary | |
PropertyBag |
getAttributes()
Returns the property bag for the data source connection. |
ConnectionInfoKind |
getKind()
Returns the kind of connection. |
java.lang.String |
getPassword()
Returns the password used to connect to the data source. |
java.lang.String |
getUserName()
Returns the user name used to connect to the data source. |
boolean |
isMatch(IConnectionInfo info,
boolean completeMatching)
Checks whether two connections match. |
void |
setAttributes(PropertyBag attributes)
Sets the property bag for the data source connection. |
void |
setKind(ConnectionInfoKind kind)
Returns the kind of connection. |
void |
setPassword(java.lang.String password)
Returns the password used to connect to the data source. |
void |
setUserName(java.lang.String userName)
Sets the user name used to connect to the data source. |
Method Detail |
public PropertyBag getAttributes()
Returns the property bag for the data source connection.
PropertyBag
object.public ConnectionInfoKind getKind()
Returns the kind of connection. For example, connection kinds include SQL, query, meta data, database file, and Crystal Report Query Engine (CRQE).
ConnectionInfoKind
object.public java.lang.String getPassword()
Returns the password used to connect to the data source.
String
.public java.lang.String getUserName()
Returns the user name used to connect to the data source.
String
.public boolean isMatch(IConnectionInfo info, boolean completeMatching)
Checks whether two connections match. Returns true
if they match,
and false
otherwise.
info
- The IConnectionInfo
object that this connection will be
compared against.completeMatching
- A boolean
specifying whether to use complete matching.
By default, this is set to true
. If true
, all members of the object are compared.
When all members of the object have been compared, a value of true
is returned if
all members are exactly the same. If set to false
, all members of the object are
compared and a value of true
is returned if the mismatch is caused because one of the
comparing members has an empty string, but all of the remaining members match.
true
if they match, and false
otherwise.public void setAttributes(PropertyBag attributes)
Sets the property bag for the data source connection.
attributes
- The property bag as a PropertyBag
object.public void setKind(ConnectionInfoKind kind)
Returns the kind of connection. For example, connection kinds include SQL, query, meta data, database file, and Crystal Report Query Engine (CRQE).
kind
- The connection kind as a
ConnectionInfoKind
object.public void setPassword(java.lang.String password)
Returns the password used to connect to the data source.
password
- The password as a String
.public void setUserName(java.lang.String userName)
Sets the user name used to connect to the data source.
userName
- The user name as a String
.