com.esri.arcgis.geodatabase
Interface IMemoryRelationshipClassName

All Superinterfaces:
Serializable
All Known Implementing Classes:
MemoryRelationshipClassName

public interface IMemoryRelationshipClassName
extends Serializable

Provides access to members that define a memory relationship class name.

Remarks

The IMemoryRelationshipClassName interface contains properties that correspond to the parameters used with the IMemoryRelationshipClassFactory::Open method. These include the Origin and Destination tables, the fields and the forward and backward path names.

The only parameters from the IMemoryRelationshipClassFactory::Open method that don't have a corresponding property in IMemoryRelationshipClassName are the name and the cardinality. The name can be set using the IDatasetName interface and the cardinality can be set using the IRelationshipClassName interface. Both of these interfaces are inherited by MemoryRelationshipClassName.

The diagram below describes the associations that define a MemoryRelationshipClass .

Since a MemoryRelationshipClass implements IDataset, you can use the IDataset::FullName property to get a MemoryRelationshipClassName object that corresponds to an existing MemoryRelationshipClass.

See the IName interface topic for more information on Name objects in general.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IGPDataType.getFullName()

Method Summary
 String getBackwardPathLabel()
          The back label of the relationship.
 IName getDestinationName()
          The name object of the destination class of the memory relationship.
 String getForwardPathLabel()
          The forward label of the relationship.
 String getOriginForeignKey()
          Origin foreign key field name.
 IName getOriginName()
          The name object for the origin table of the memory relationship.
 String getOriginPrimaryKey()
          Origin primary key field name.
 void setBackwardPathLabel(String backLabel)
          The back label of the relationship.
 void setDestinationNameByRef(IName destinationName)
          The name object of the destination class of the memory relationship.
 void setForwardPathLabel(String forwardLabel)
          The forward label of the relationship.
 void setOriginForeignKey(String originPrimaryKey)
          Origin foreign key field name.
 void setOriginNameByRef(IName originName)
          The name object for the origin table of the memory relationship.
 void setOriginPrimaryKey(String originPrimaryKey)
          Origin primary key field name.
 

Method Detail

getOriginName

IName getOriginName()
                    throws IOException,
                           AutomationException
The name object for the origin table of the memory relationship.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOriginNameByRef

void setOriginNameByRef(IName originName)
                        throws IOException,
                               AutomationException
The name object for the origin table of the memory relationship.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
originName - A reference to a com.esri.arcgis.system.IName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDestinationName

IName getDestinationName()
                         throws IOException,
                                AutomationException
The name object of the destination class of the memory relationship.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDestinationNameByRef

void setDestinationNameByRef(IName destinationName)
                             throws IOException,
                                    AutomationException
The name object of the destination class of the memory relationship.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
destinationName - A reference to a com.esri.arcgis.system.IName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getForwardPathLabel

String getForwardPathLabel()
                           throws IOException,
                                  AutomationException
The forward label of the relationship.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setForwardPathLabel

void setForwardPathLabel(String forwardLabel)
                         throws IOException,
                                AutomationException
The forward label of the relationship.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBackwardPathLabel

String getBackwardPathLabel()
                            throws IOException,
                                   AutomationException
The back label of the relationship.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBackwardPathLabel

void setBackwardPathLabel(String backLabel)
                          throws IOException,
                                 AutomationException
The back label of the relationship.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOriginPrimaryKey

String getOriginPrimaryKey()
                           throws IOException,
                                  AutomationException
Origin primary key field name.

Remarks

This is the name of the field from the table referenced by the OriginName property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOriginPrimaryKey

void setOriginPrimaryKey(String originPrimaryKey)
                         throws IOException,
                                AutomationException
Origin primary key field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOriginForeignKey

String getOriginForeignKey()
                           throws IOException,
                                  AutomationException
Origin foreign key field name.

Remarks

This is the name of the field from the table referenced by the DestinationName property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOriginForeignKey

void setOriginForeignKey(String originPrimaryKey)
                         throws IOException,
                                AutomationException
Origin foreign key field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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