com.esri.arcgis.carto
Interface IRelateInfo2

All Superinterfaces:

Serializable

public interface IRelateInfo2
extends Serializable

Provides access to members that describe a relate.

Product Availability

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

Method Summary

int	getCardinality() Cardinality for the relationship.
String	getKeyField() Keyfield of the table related to.
String	getKeyFieldInRelationshipTable() Key field in Relationship Table.
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.
int	getRelationshipTableId() Id of table that maintains the relationhip information between the source and destination table.
int	getRole() Role of this table in the relationship.
boolean	isComposite() Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the relationship to a table.

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.

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.

getRole

int getRole()
            throws IOException,
                   AutomationException

Role of this table in the relationship.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriRelRole constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCardinality

int getCardinality()
                   throws IOException,
                          AutomationException

Cardinality for the relationship.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriRelCardinality constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyField

String getKeyField()
                   throws IOException,
                          AutomationException

Keyfield of the table related to.

Product Availability

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

Returns:

The keyField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isComposite

boolean isComposite()
                    throws IOException,
                           AutomationException

Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.

Product Availability

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

Returns:

The composite

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipTableId

int getRelationshipTableId()
                           throws IOException,
                                  AutomationException

Id of table that maintains the relationhip information between the source and destination table.

Product Availability

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

Returns:

The tableID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyFieldInRelationshipTable

String getKeyFieldInRelationshipTable()
                                      throws IOException,
                                             AutomationException

Key field in Relationship Table.

Product Availability

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

Returns:

The keyField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.