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

public interface IReportTablePrefix

The IReportTablePrefix interface allows you to change the table prefix template.

Method Summary

java.lang.String	getMappedTablePrefix() Returns the mapped table prefix.
java.lang.String	getTablePrefix() Returns the original table prefix.
boolean	getUseMappedTablePrefix() Deprecated. should use IReportTablePrefix.isUseMappedTablePrefix() instead
boolean	isUseMappedTablePrefix() Returns whether the mapped table prefix is used.
void	setMappedTablePrefix(java.lang.String mappedPrefix) Sets the mapped table prefix.
void	setTablePrefix(java.lang.String tablePrefix) Sets the original table prefix.
void	setUseMappedTablePrefix(boolean bUseMapping) Sets the flag indicating whether the mapped table index is used .

Method Detail

getTablePrefix

java.lang.String getTablePrefix()
                                throws SDKException

Returns the original table prefix.

Returns:

A String containing the original table prefix.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setTablePrefix

void setTablePrefix(java.lang.String tablePrefix)
                    throws SDKException

Sets the original table prefix. This constitutes the key that must map directly to the report. Changing this property is dangerous and not recommended

Parameters:

tablePrefix - A String containing the original table prefix.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMappedTablePrefix

java.lang.String getMappedTablePrefix()
                                      throws SDKException

Returns the mapped table prefix.

Returns:

A String containing the mapped table prefix.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMappedTablePrefix

void setMappedTablePrefix(java.lang.String mappedPrefix)
                          throws SDKException

Sets the mapped table prefix.

Parameters:

mappedPrefix - A String containing the mapped table prefix.

Throws:

SDKException

getUseMappedTablePrefix

boolean getUseMappedTablePrefix()
                                throws SDKException

Deprecated. should use IReportTablePrefix.isUseMappedTablePrefix() instead

Gets whether or not the mapped table prefix is used.

Returns:

true if the mapped table prefix is used.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isUseMappedTablePrefix

boolean isUseMappedTablePrefix()
                               throws SDKException

Returns whether the mapped table prefix is used.

Returns:

true if the mapped table prefix is used.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setUseMappedTablePrefix

void setUseMappedTablePrefix(boolean bUseMapping)
                             throws SDKException

Sets the flag indicating whether the mapped table index is used .

Parameters:

bUseMapping - A boolean for using the mapped table prefix.

Throws:

SDKException - This is thrown if the process is unsuccessful.