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

All Known Implementing Classes:

ConnectionInfo

public interface IConnectionInfo

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

getAttributes

public PropertyBag getAttributes()

Returns the property bag for the data source connection.

Returns:

The property bags as a PropertyBag object.

getKind

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

Returns:

The connection kind as a ConnectionInfoKind object.

getPassword

public java.lang.String getPassword()

Returns the password used to connect to the data source.

Returns:

The password as a String.

getUserName

public java.lang.String getUserName()

Returns the user name used to connect to the data source.

Returns:

The user name as a String.

isMatch

public boolean isMatch(IConnectionInfo info,
                       boolean completeMatching)

Checks whether two connections match. Returns true if they match, and false otherwise.

Parameters:

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.

Returns:

true if they match, and false otherwise.

setAttributes

public void setAttributes(PropertyBag attributes)

Sets the property bag for the data source connection.

Parameters:

attributes - The property bag as a PropertyBag object.

setKind

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

Parameters:

kind - The connection kind as a ConnectionInfoKind object.

setPassword

public void setPassword(java.lang.String password)

Returns the password used to connect to the data source.

Parameters:

password - The password as a String.

setUserName

public void setUserName(java.lang.String userName)

Sets the user name used to connect to the data source.

Parameters:

userName - The user name as a String.