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

All Superinterfaces:
IClone
All Known Subinterfaces:
ICommandTable, IProcedure
All Known Implementing Classes:
CommandTable, Procedure, Table

public interface ITable
extends IClone

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.
 IConnection getConnection()
           
 IConnectionInfo getConnectionInfo()
           Returns information about the connection to the database that the table belongs to.
 Fields<IField> getDataFields()
           Returns the data fields that the table contains.
 java.lang.String getDescription()
           Returns a description of the table.
 Indexes getIndexes()
           
 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 setConnection(IConnection connection)
           
 void setConnectionInfo(IConnectionInfo connectionInfo)
           Sets information about the connection to the database that the table belongs to.
 void setDataFields(Fields<IField> dataFields)
           Sets the data fields that the table contains.
 void setDescription(java.lang.String description)
           Sets the description of the table.
 void setIndexes(Indexes indexes)
           
 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

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

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

Fields<IField> getDataFields()

Returns the data fields that the table contains.

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

getDescription

java.lang.String getDescription()

Returns a description of the table.

Returns:
A String containing a description of the table.

getName

java.lang.String getName()

Returns the name of the table.

Returns:
A String containing the name of the table.

getQualifiedName

java.lang.String getQualifiedName()

Returns the fully qualified name of the table.

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

getIndexes

Indexes getIndexes()

setAlias

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

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

void setDataFields(Fields<IField> dataFields)

Sets the data fields that the table contains.

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

setDescription

void setDescription(java.lang.String description)

Sets the description of the table.

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

setName

void setName(java.lang.String name)

Sets the name of the table.

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

setQualifiedName

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.

getConnection

IConnection getConnection()

setConnection

void setConnection(IConnection connection)

setIndexes

void setIndexes(Indexes indexes)