com.esri.arcgis.geodatabase
Interface IGPRelationshipClassKey

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPRelationshipClassKey

public interface IGPRelationshipClassKey
extends Serializable

Provides access to methods that describe a key of a relationship class data element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getClassKeyName()
          The name of the field that contains object class identifiers.
 int getKeyRole()
          The role of the key in the relationship class.
 String getObjectKeyName()
          The name of the field that contains object identifiers.
 void setClassKeyName(String name)
          The name of the field that contains object class identifiers.
 void setKeyRole(int role)
          The role of the key in the relationship class.
 void setObjectKeyName(String name)
          The name of the field that contains object identifiers.
 

Method Detail

setKeyRole

void setKeyRole(int role)
                throws IOException,
                       AutomationException
The role of the key in the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
role - A com.esri.arcgis.geodatabase.esriRelKeyRole constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyRole

int getKeyRole()
               throws IOException,
                      AutomationException
The role of the key in the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriRelKeyRole constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectKeyName

void setObjectKeyName(String name)
                      throws IOException,
                             AutomationException
The name of the field that contains object identifiers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObjectKeyName

String getObjectKeyName()
                        throws IOException,
                               AutomationException
The name of the field that contains object identifiers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClassKeyName

void setClassKeyName(String name)
                     throws IOException,
                            AutomationException
The name of the field that contains object class identifiers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassKeyName

String getClassKeyName()
                       throws IOException,
                              AutomationException
The name of the field that contains object class identifiers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.