com.esri.arcgis.carto
Interface IRelateInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

RelateInfo

public interface IRelateInfo
extends Serializable

Provides access to members that describe a relate.

Remarks

If a layer or a standalonetable participates in a relationship, MapServer advertises that by populating those information as RelateInfo.

When there are more than one relationships exist between the same source and destination table(s) or layer(s), RelationshipID can be used to uniquely identify a relationship.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

String	getName() The name of the relationship to a table.
int	getRelatedTableID() ID of the table related to.
int	getRelationshipID() Identifies the specific relationship for a related table.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the relationship to a table.

Remarks

For Geodatabase relationship class, the name is either the backward or forward label.

For relationship that is created in map, the name is same the table/layer it is related to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipID

int getRelationshipID()
                      throws IOException,
                             AutomationException

Identifies the specific relationship for a related table.

Description

It is an integer that uniquely identifies all relationship available in the source map document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The relationshipID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelatedTableID

int getRelatedTableID()
                      throws IOException,
                             AutomationException

ID of the table related to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The relatedTableID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.