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

All Known Implementing Classes:
TableLink

public interface ITableLink

This object implements a link between two tables. The tables may be in different databases. A field from the one table (called the source table) and a field from the other table (called the target table) are used to link the two tables together.

Note: The ITableLink APIs only support Crystal Report Writer version 8.5 link types. Version 9 or greater links are treated as an Advanced type TableJoinType. You cannot modify existing link objects to Advanced type. Use the ITableJoin APIs to modify a version 9 or greater link.

See Also:
com.crystaldecisions.sdk.occa.report.application.DatabaseController#addTable(ITable, TableLinks) DatabaseController.addTable(ITable, TableLinks)} {@link com.crystaldecisions.sdk.occa.report.application.DatabaseController#addTableLink(ITableLink) DatabaseController.addTableLink(ITableLink)} {@link com.crystaldecisions.sdk.occa.report.application.DatabaseController#modifyTableLink(ITableLink, ITableLink) DatabaseController.modifyTableLink(ITableLink, ITableLink)} {@link com.crystaldecisions.sdk.occa.report.application.DatabaseController#removeTableLink(ITableLink) DatabaseController.removeTableLink(ITableLink)} {@link com.crystaldecisions.sdk.occa.report.application.DatabaseController#findTableLink(Object, Object) DatabaseController.findTableLink(Object, Object)}

Method Summary
 TableJoinType getJoinType()
           Returns the manner in which the tables are joined.
 IStrings getSourceFieldNames()
           Returns the names of the fields contained in the source table to be linked.
 java.lang.String getSourceTableAlias()
           Returns the source table's alias.
 IStrings getTargetFieldNames()
           Returns the names of the fields contained in the target table to be linked.
 java.lang.String getTargetTableAlias()
           Returns the target table's alias.
 void setJoinType(TableJoinType joinType)
           Sets the manner in which the tables are joined.
 void setSourceFieldNames(IStrings sourceFieldNames)
           Sets the names of the fields contained in the source table to be linked.
 void setSourceTableAlias(java.lang.String srcTableAlias)
           Sets the source table's alias.
 void setTargetFieldNames(IStrings targetFieldNames)
           Sets the names of the fields contained in the target table to be linked.
 void setTargetTableAlias(java.lang.String targetTableAlias)
           Sets the target table's alias.
 

Method Detail

getJoinType

TableJoinType getJoinType()

Returns the manner in which the tables are joined.

Returns:
A TableJoinType object that specifies the manner in which the tables are joined.
See Also:
TableJoinType

getSourceFieldNames

IStrings getSourceFieldNames()

Returns the names of the fields contained in the source table to be linked.

Returns:
An IStrings object containing the names of the fields contained in the source table to be linked.

getSourceTableAlias

java.lang.String getSourceTableAlias()

Returns the source table's alias.

Returns:
A String containing the source table's alias.

getTargetFieldNames

IStrings getTargetFieldNames()

Returns the names of the fields contained in the target table to be linked.

Returns:
An IStrings object containing the names of the fields contained in the target table to be linked.

getTargetTableAlias

java.lang.String getTargetTableAlias()

Returns the target table's alias.

Returns:
A String containing the target table's alias.

setJoinType

void setJoinType(TableJoinType joinType)

Sets the manner in which the tables are joined.

Parameters:
joinType - A TableJoinType object that specifies the manner in which the tables are joined.

setSourceFieldNames

void setSourceFieldNames(IStrings sourceFieldNames)

Sets the names of the fields contained in the source table to be linked.

Parameters:
sourceFieldNames - An IStrings object containing the names of the fields contained in the source table to be linked.

setSourceTableAlias

void setSourceTableAlias(java.lang.String srcTableAlias)

Sets the source table's alias.

Parameters:
srcTableAlias - A String containing the source table's alias.

setTargetFieldNames

void setTargetFieldNames(IStrings targetFieldNames)

Sets the names of the fields contained in the target table to be linked.

Parameters:
targetFieldNames - An IStrings object containing the names of the fields contained in the target table to be linked.

setTargetTableAlias

void setTargetTableAlias(java.lang.String targetTableAlias)

Sets the target table's alias.

Parameters:
targetTableAlias - A String containing the target table's alias.