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

All Superinterfaces:
IClone
All Known Implementing Classes:
FieldLink

public interface IFieldLink
extends IClone

This interface represents a link between two fields in a table join. The from field in the source table and the to field in the target table are used to specify one link in a TableJoin.

See Also:
TableJoin.setFieldLinks(FieldLinks)

Method Summary
 IField getFromField()
          Returns the from field of the link.
 FieldLinkOperator getLinkOperator()
          Returns the manner in which the tables are joined.
 IField getToField()
          Returns the to field of the link.
 void setFromField(IField fromField)
          Sets the from field of the link.
 void setLinkOperator(FieldLinkOperator linkOperator)
          Sets the manner in which the tables are joined.
 void setToField(IField ToField)
          Sets the to field of the link.
 

Method Detail

getFromField

IField getFromField()
Returns the from field of the link.

Returns:
A String containing the from field of the link.

setFromField

void setFromField(IField fromField)
Sets the from field of the link.

Parameters:
fromField - A IField containing the from field of the link.

getToField

IField getToField()
Returns the to field of the link.

Returns:
A IField containing the to field of the link.

setToField

void setToField(IField ToField)
Sets the to field of the link.

Parameters:
ToField - A IField containing the to field of the link.

getLinkOperator

FieldLinkOperator getLinkOperator()
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

setLinkOperator

void setLinkOperator(FieldLinkOperator linkOperator)
Sets the manner in which the tables are joined.

Parameters:
linkOperator - A FieldLinkOperator object that specifies the manner in which the tables are joined.