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


public interface ITable

This interface defines a table from a database. The data contained in the table may be accessed through the getDataFields method.


Method Summary
 java.lang.String getAlias()
           Returns the alias that is used to identify the table.
 IConnectionInfo getConnectionInfo()
           Returns information about the connection to the database that the table belongs to.
 Fields getDataFields()
           Returns the data fields that the table contains.
 java.lang.String getDescription()
           Returns a description of the table.
 java.lang.String getName()
           Returns the name of the table.
 java.lang.String getQualifiedName()
           Returns the fully qualified name of the table.
 void setAlias(java.lang.String alias)
           Sets the alias that is used to identify the table.
 void setConnectionInfo(IConnectionInfo connectionInfo)
           Sets information about the connection to the database that the table belongs to.
 void setDataFields(Fields dataFields)
           Sets the data fields that the table contains.
 void setDescription(java.lang.String description)
           Sets the description of the table.
 void setName(java.lang.String name)
           Sets the name of the table.
 void setQualifiedName(java.lang.String qualifiedName)
           Sets the fully qualified name of the table.
 

Method Detail

getAlias

public java.lang.String getAlias()

Returns the alias that is used to identify the table. This may not be the same as the name of the table.

Returns:
A String containing the alias that is used to identify the table.

getConnectionInfo

public IConnectionInfo getConnectionInfo()

Returns information about the connection to the database that the table belongs to.

Returns:
An IConnectionInfo object that contains information about the connection to the database that the table belongs to.

getDataFields

public Fields getDataFields()

Returns the data fields that the table contains.

Returns:
A Fields object containing the data fields that the table contains.

getDescription

public java.lang.String getDescription()

Returns a description of the table.

Returns:
A String containing a description of the table.

getName

public java.lang.String getName()

Returns the name of the table.

Returns:
A String containing the name of the table.

getQualifiedName

public java.lang.String getQualifiedName()

Returns the fully qualified name of the table.

Returns:
A String containing the fully qualified name of the table.

setAlias

public void setAlias(java.lang.String alias)

Sets the alias that is used to identify the table. This may not be the same as the name of the table.

Parameters:
alias - A String containing the alias that is used to identify the table.

setConnectionInfo

public void setConnectionInfo(IConnectionInfo connectionInfo)

Sets information about the connection to the database that the table belongs to.

Parameters:
connectionInfo - An IConnectionInfo object that contains information about the connection to the database that the table belongs to.

setDataFields

public void setDataFields(Fields dataFields)

Sets the data fields that the table contains.

Parameters:
dataFields - A Fields object containing the data fields that the table contains.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the table.

Parameters:
description - A String containing a description of the table.

setName

public void setName(java.lang.String name)

Sets the name of the table.

Parameters:
name - A String containing the name of the table.

setQualifiedName

public void setQualifiedName(java.lang.String qualifiedName)

Sets the fully qualified name of the table.

Parameters:
qualifiedName - A String containing the fully qualified name of the table.