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

All Superinterfaces:
IClone
All Known Implementing Classes:
TableJoin

public interface ITableJoin
extends IClone

This interface allows you to modify a join between two tables. The tables may be in different databases. Fields from the one table (called the source table) and fields from the other table (called the target table) are used to join the two tables together.


Method Summary
 TableJoinEnforced getEnforceJoin()
          Returns the manner in which the tables are joined.
 FieldLinks getFieldLinks()
          Returns the collection of the field links in this table join.
 TableJoinOperator getJoinOperator()
          Returns the manner in which the tables are joined.
 java.lang.String getSourceTableAlias()
          Returns the source table's alias.
 java.lang.String getTargetTableAlias()
          Returns the target table's alias.
 void setEnforceJoin(TableJoinEnforced enforceJoin)
          Sets the manner in which the tables are joined.
 void setFieldLinks(FieldLinks links)
          Sets the collection of the field links in this table join.
 void setJoinOperator(TableJoinOperator joinOperator)
          Sets the manner in which the tables are joined.
 void setSourceTableAlias(java.lang.String srcTableAlias)
          Sets the source table's alias.
 void setTargetTableAlias(java.lang.String targetTableAlias)
          Sets the target table's alias.
 

Method Detail

getSourceTableAlias

java.lang.String getSourceTableAlias()
Returns the source table's alias.

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

setSourceTableAlias

void setSourceTableAlias(java.lang.String srcTableAlias)
Sets the source table's alias.

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

getTargetTableAlias

java.lang.String getTargetTableAlias()
Returns the target table's alias.

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

setTargetTableAlias

void setTargetTableAlias(java.lang.String targetTableAlias)
Sets the target table's alias.

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

getFieldLinks

FieldLinks getFieldLinks()
Returns the collection of the field links in this table join.

Returns:
An FieldLinks object containing the collection of the field links table to be linked.

setFieldLinks

void setFieldLinks(FieldLinks links)
Sets the collection of the field links in this table join.

Parameters:
links - An FieldLinks object containing the collection of the field links.

getJoinOperator

TableJoinOperator getJoinOperator()
Returns the manner in which the tables are joined.

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

setJoinOperator

void setJoinOperator(TableJoinOperator joinOperator)
Sets the manner in which the tables are joined.

Parameters:
joinOperator - A TableJoinOperator object that specifies the manner in which the tables are joined.

getEnforceJoin

TableJoinEnforced getEnforceJoin()
Returns the manner in which the tables are joined.

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

setEnforceJoin

void setEnforceJoin(TableJoinEnforced enforceJoin)
Sets the manner in which the tables are joined.

Parameters:
enforceJoin - A TableJoinEnforced object that specifies the manner in which the tables are joined.