com.crystaldecisions.sdk.plugin.desktop.common
Interface IReportLogon

public interface IReportLogon

The IReportLogon interface contains logon information for a database the report must retrieve data from. It consists of the following methods that provide such information. The IReportLogon interface is most frequently used with the IReportProcessingInfo interface.

See Also:

IReportProcessingInfo

Nested Class Summary

static interface	IReportLogon.CeReportLogonMode Specifies the report logon mode
static interface	IReportLogon.CeReportServerType Specifies the Report Database Server Type.

Method Summary

ConnectionInfo	getConnectionInfo() Returns an equivalent ConnectionInfo object that is compatible with the Crystal Reports Web viewer.
java.lang.String	getCustomDatabaseDLLName() Returns the custom database dll name required for logon.
java.lang.String	getCustomDatabaseName() Returns the custom database name.
java.lang.String	getCustomServerName() Returns the custom name of the server which hosts the database.
int	getCustomServerType() Returns custom database server type from the report.
java.lang.String	getCustomUserName() Returns the custom user name required to logon to the database server.
java.lang.String	getDatabaseDLLName() Returns original database dll name from the report.
java.lang.String	getDatabaseName() Returns the name of the database.
java.lang.String	getDatabaseServerType() Returns the type of the database server, when the Connection Server is used.
java.lang.String	getEncryptedCustomPassword() Returns the custom password required to logon to the database server.
java.lang.String	getEncryptedPassword() Returns the password required to logon to the database server.
java.lang.String	getNetworkLayer() Returns the network layer that is used to communication with the database, when the Connection Server is used.
int	getReportLogonMode() Returns the report logon mode to be used for this connection
ISDKSet	getReportTablePrefixes() Returns a collection of table prefix mappings that allows the user to define a new table location prefix for every table in the custom DB section.
java.lang.String	getServerName() Returns the name of the server which hosts the database.
int	getServerType() Returns original database server type from the report.
java.lang.String	getSubReportName() Returns the sub report name that this logon information applies to.
java.lang.String	getUserName() Returns the user name required to logon to the database server.
boolean	isCustomizable() Indicates whether this logon's database information is customizable or not.
boolean	isCustomPasswordNotEmpty() Returns a boolean indicating whether the custom password is set and not empty.
boolean	isCustomPasswordSet() Returns a boolean indicating whether the custom password is set.
boolean	isOLAPDataSource() Returns whether or not original data source is a OLAP data source.
boolean	isOriginalDataSource() Returns whether or not original data source should be used.
boolean	isPasswordNotEmpty() Returns a boolean indicating whether the password is set and not empty.
boolean	isPasswordSet() Returns a boolean indicating whether the password is set.
boolean	isPromptOnDemandViewing() Returns whether the logon information should be prompted for when viewing on-demand reports.
boolean	isSSOEnabled() Returns a boolean that indicates whether single sign-on authentication (SSO) is enabled.
void	setCustomDatabaseDLLName(java.lang.String DllName) Sets the custom database dll name required for logon.
void	setCustomDatabaseName(java.lang.String DatabaseName) Sets the custom database name.
void	setCustomPassword(java.lang.String Password) Sets the custom password needed to logon to the database server.
void	setCustomServerName(java.lang.String ServerName) Sets the custom server name required to logon to the database server.
void	setCustomServerType(int serverType) Sets the custom server type for the report.
void	setCustomUserName(java.lang.String UserName) Sets the custom user name required to logon to the database server.
void	setDatabaseName(java.lang.String DatabaseName) Sets the name of the database.
void	setDatabaseServerType(java.lang.String databaseServerType) Sets the type of the database server, when the Connection Server is used.
void	setNetworkLayer(java.lang.String networkLayer) Sets the network layer that is used to communication with the database, when the Connection Server is used.
void	setOriginalDataSource(boolean bUseOriginalDS) Sets whether or not the original data source should be used.
void	setPassword(java.lang.String Password) Sets the password needed to logon to the database server.
void	setPromptOnDemandViewing(boolean promptOnDemand) Sets whether the logon information should be prompted for when viewing on-demand reports.
void	setReportLogonMode(int value) Sets the report logon mode to be used for this connection
void	setServerName(java.lang.String ServerName) Sets the name of the server which hosts the database.
void	setSSOEnabled(boolean value) Sets a boolean that indicates whether single sign-on authentication (SSO) is enabled.
void	setSubReportName(java.lang.String SubRptName) Deprecated.
void	setUserName(java.lang.String UserName) Sets the user name required to logon to the database server.
boolean	shouldDisplayOriginalConfiguration() For internal use only

Method Detail

getDatabaseName

java.lang.String getDatabaseName()
                                 throws SDKException

Returns the name of the database.

Returns:

A String containing the database name.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDatabaseName

void setDatabaseName(java.lang.String DatabaseName)

Sets the name of the database. This property is part of the key that maps an IReportLogon to a connection in the report. Changing this property is dangerous and not recommended.

Parameters:

DatabaseName - A String containing the database name.

setPassword

void setPassword(java.lang.String Password)

Sets the password needed to logon to the database server.

Parameters:

Password - A String specifying the password needed to logon to the database server.

isPromptOnDemandViewing

boolean isPromptOnDemandViewing()
                                throws SDKException

Returns whether the logon information should be prompted for when viewing on-demand reports.

Returns:

true if logon information should be prompted when viewing on demand.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPromptOnDemandViewing

void setPromptOnDemandViewing(boolean promptOnDemand)

Sets whether the logon information should be prompted for when viewing on-demand reports.

Parameters:

promptOnDemand - true if logon information should be prompted for when viewing on demand.

getServerName

java.lang.String getServerName()
                               throws SDKException

Returns the name of the server which hosts the database.

Returns:

A String containing the server name.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setServerName

void setServerName(java.lang.String ServerName)

Sets the name of the server which hosts the database. This property is part of the key that maps an IReportLogon to a connection in the report. Changing this property is dangerous and not recommended.

Parameters:

ServerName - A String specifying the server name.

getSubReportName

java.lang.String getSubReportName()
                                  throws SDKException

Returns the sub report name that this logon information applies to. Note, this is not the name of the main report. It is the name of the subreport that the logon information applies to.

Note: If the logon information applies to the main report, the return value will be an empty string.

Returns:

A String containing the sub report name.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSubReportName

void setSubReportName(java.lang.String SubRptName)

Deprecated.

Sets the sub report name that this logon information applies to. Note, this is not the name of the main report.

Parameters:

SubRptName - A String containing the sub report name.

getUserName

java.lang.String getUserName()
                             throws SDKException

Returns the user name required to logon to the database server.

Returns:

A String containing the user name required to logon to the database server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setUserName

void setUserName(java.lang.String UserName)

Sets the user name required to logon to the database server.

Parameters:

bstrUserName - A String containing the user name required to logon to the database.

getServerType

int getServerType()
                  throws SDKException

Returns original database server type from the report.

Returns:

A int containing original database server type, this will be of type CeReportServerType

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportLogon.CeReportServerType

getDatabaseDLLName

java.lang.String getDatabaseDLLName()
                                    throws SDKException

Returns original database dll name from the report.

Returns:

A String containing the original database dll name from the report.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportLogon.CeReportServerType

getCustomServerName

java.lang.String getCustomServerName()
                                     throws SDKException

Returns the custom name of the server which hosts the database.

Returns:

A String containing the custom server name.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setCustomServerName

void setCustomServerName(java.lang.String ServerName)
                         throws SDKException

Sets the custom server name required to logon to the database server.

Parameters:

ServerName - A String containing the custom server name required to logon to the database.

Throws:

SDKException - This is thrown if data source is not customizable.

getNetworkLayer

java.lang.String getNetworkLayer()
                                 throws SDKException

Returns the network layer that is used to communication with the database, when the Connection Server is used.

Returns:

A String representing the network layer.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

com.crystaldecisions.sdk.plugin.desktop.common.IReportLogon.CeNetworkLayer

setNetworkLayer

void setNetworkLayer(java.lang.String networkLayer)
                     throws SDKException

Sets the network layer that is used to communication with the database, when the Connection Server is used.

Parameters:

networkLayer - A String representing the network layer.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

com.crystaldecisions.sdk.plugin.desktop.common.IReportLogon.CeNetworkLayer

getDatabaseServerType

java.lang.String getDatabaseServerType()
                                       throws SDKException

Returns the type of the database server, when the Connection Server is used.

Returns:

A String representing the database server type.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

com.crystaldecisions.sdk.plugin.desktop.common.IReportLogon.CeDatabaseServerType

setDatabaseServerType

void setDatabaseServerType(java.lang.String databaseServerType)
                           throws SDKException

Sets the type of the database server, when the Connection Server is used.

Parameters:

databaseServerType - A String representing the database server type.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

com.crystaldecisions.sdk.plugin.desktop.common.IReportLogon.CeDatabaseServerType

getCustomDatabaseName

java.lang.String getCustomDatabaseName()
                                       throws SDKException

Returns the custom database name.

Returns:

A String containing the custom database name.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setCustomDatabaseName

void setCustomDatabaseName(java.lang.String DatabaseName)
                           throws SDKException

Sets the custom database name.

Parameters:

DatabaseName - A String containing database name.

Throws:

SDKException - This is thrown if data source is not customizable.

getCustomUserName

java.lang.String getCustomUserName()
                                   throws SDKException

Returns the custom user name required to logon to the database server.

Returns:

A String containing the custom user name required to logon to the database server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setCustomUserName

void setCustomUserName(java.lang.String UserName)
                       throws SDKException

Sets the custom user name required to logon to the database server.

Parameters:

UserName - A int containing the custom user name required to logon to the database.

Throws:

SDKException - This is thrown if data source is not customizable.

setCustomPassword

void setCustomPassword(java.lang.String Password)
                       throws SDKException

Sets the custom password needed to logon to the database server.

Parameters:

Password - A String specifying the custom password needed to logon to the database server.

Throws:

SDKException - This is thrown if data source is not customizable.

getCustomServerType

int getCustomServerType()
                        throws SDKException

Returns custom database server type from the report.

Returns:

A CeReportServerType containing database server type for the report.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportLogon.CeReportServerType

getConnectionInfo

ConnectionInfo getConnectionInfo()
                                 throws SDKException

Returns an equivalent ConnectionInfo object that is compatible with the Crystal Reports Web viewer.

Returns:

A ConnectionInfo object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setCustomServerType

void setCustomServerType(int serverType)
                         throws SDKException

Sets the custom server type for the report.

Parameters:

serverType - A int containing the custom server for the report.

Throws:

SDKException - This is thrown if any error occurs during the data translation process.

getCustomDatabaseDLLName

java.lang.String getCustomDatabaseDLLName()
                                          throws SDKException

Returns the custom database dll name required for logon.

Returns:

A String containing the custom database dll name required to logon.

Throws:

SDKException - This is thrown if the data source is not customizable.

See Also:

IReportLogon.CeReportServerType

setCustomDatabaseDLLName

void setCustomDatabaseDLLName(java.lang.String DllName)
                              throws SDKException

Sets the custom database dll name required for logon.

Parameters:

DllName - A String containing the custom database dll name required for logon.

Throws:

SDKException - This is thrown if data source is OLAP.

isOriginalDataSource

boolean isOriginalDataSource()
                             throws SDKException

Returns whether or not original data source should be used.

Returns:

true original data source should be used.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setOriginalDataSource

void setOriginalDataSource(boolean bUseOriginalDS)
                           throws SDKException

Sets whether or not the original data source should be used.

Parameters:

bUseOriginalDS - true if original data source should be used.

Throws:

SDKException - This is thrown if data source is not customizable.

isOLAPDataSource

boolean isOLAPDataSource()
                         throws SDKException

Returns whether or not original data source is a OLAP data source.

Returns:

true if original data source is OLAP data source.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getReportTablePrefixes

ISDKSet getReportTablePrefixes()
                               throws SDKException

Returns a collection of table prefix mappings that allows the user to define a new table location prefix for every table in the custom DB section.

Returns:

a collection of IReportTablePrefix objects, each of which contain database mapping information.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportTablePrefix

isCustomizable

boolean isCustomizable()
                       throws SDKException

Indicates whether this logon's database information is customizable or not. Logon information is customizable if it does not refer to an OLAP data source or a metadata data source.

Returns:

true if this logon database info is customizable. false otherwise.

Throws:

SDKException - if the property SI_ISCUSTOMIZABLE is not found in the bag

isPasswordSet

boolean isPasswordSet()
                      throws SDKException

Returns a boolean indicating whether the password is set.

Returns:

true if the password is set, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isPasswordNotEmpty

boolean isPasswordNotEmpty()
                           throws SDKException

Returns a boolean indicating whether the password is set and not empty.

Returns:

true if the password is set and not empty, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isCustomPasswordSet

boolean isCustomPasswordSet()
                            throws SDKException

Returns a boolean indicating whether the custom password is set.

Returns:

true if the password is set, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isCustomPasswordNotEmpty

boolean isCustomPasswordNotEmpty()
                                 throws SDKException

Returns a boolean indicating whether the custom password is set and not empty.

Returns:

true if the custom password is set and not empty, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isSSOEnabled

boolean isSSOEnabled()
                     throws SDKException

Returns a boolean that indicates whether single sign-on authentication (SSO) is enabled.

Returns:

true if SSO is enabled, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSSOEnabled

void setSSOEnabled(boolean value)

Sets a boolean that indicates whether single sign-on authentication (SSO) is enabled.

Set to true to enable SSO.

Parameters:

value - A boolean that indicates whether SSO is enabled.

getEncryptedPassword

java.lang.String getEncryptedPassword()
                                      throws SDKException

Returns the password required to logon to the database server.

Returns:

A String containing the (encrypted) password required to logon to the database server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getEncryptedCustomPassword

java.lang.String getEncryptedCustomPassword()
                                            throws SDKException

Returns the custom password required to logon to the database server.

Returns:

A String containing the (encrypted) custom password required to logon to the database server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getReportLogonMode

int getReportLogonMode()

Returns the report logon mode to be used for this connection

Returns:

An int containing the report logon mode

setReportLogonMode

void setReportLogonMode(int value)
                        throws SDKException

Sets the report logon mode to be used for this connection

Parameters:

value - An int containing the report logon mode

Throws:

SDKException - This is thrown if the process is unsuccessful.

shouldDisplayOriginalConfiguration

boolean shouldDisplayOriginalConfiguration()

For internal use only