com.esri.arcgis.geodatabase
Interface IRelationshipClassContainer

All Superinterfaces:
Serializable
All Known Implementing Classes:
FeatureDataset, IRelationshipClassContainerProxy

public interface IRelationshipClassContainer
extends Serializable

Provides access to members that create, add and hand out relationship classes.

Description

The IRelationshipClassContainer interface lets you create a relationship class within a feature dataset rather than a workspace.

Remarks

The AddRelationshipClass method is effectively superseded by IDatasetContainer::AddDataset. The IDatasetContainer interface lets you move datasets between feature datasets and workspacesóboth objects implement the interface.

When To Use

The IRelationshipClassContainer interface lets you create a relationship class within a feature dataset rather than a workspace. The AddRelationshipClass method is effectively superseded by IDatasetContainer::AddDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addRelationshipClass(IRelationshipClass relationshipClass)
          Transfers ownership of a relationship class to this container.
 IRelationshipClass createRelationshipClass(String relClassName, IObjectClass originClass, IObjectClass destinationClass, String forwardLabel, String backwardLabel, int cardinality, int notification, boolean isComposite, boolean isAttributed, IFields relAttrFields, String originPrimaryKey, String destPrimaryKey, String originForeignKey, String destForeignKey)
          Creates a new relationship class in this container.
 IEnumRelationshipClass getRelationshipClasses()
          An enumerator over the RelationshipClasses in this container.
 

Method Detail

getRelationshipClasses

IEnumRelationshipClass getRelationshipClasses()
                                              throws IOException,
                                                     AutomationException
An enumerator over the RelationshipClasses in this container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

createRelationshipClass

IRelationshipClass createRelationshipClass(String relClassName,
                                           IObjectClass originClass,
                                           IObjectClass destinationClass,
                                           String forwardLabel,
                                           String backwardLabel,
                                           int cardinality,
                                           int notification,
                                           boolean isComposite,
                                           boolean isAttributed,
                                           IFields relAttrFields,
                                           String originPrimaryKey,
                                           String destPrimaryKey,
                                           String originForeignKey,
                                           String destForeignKey)
                                           throws IOException,
                                                  AutomationException
Creates a new relationship class in this container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
relClassName - The relClassName (in)
originClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)
destinationClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)
forwardLabel - The forwardLabel (in)
backwardLabel - The backwardLabel (in)
cardinality - A com.esri.arcgis.geodatabase.esriRelCardinality constant (in)
notification - A com.esri.arcgis.geodatabase.esriRelNotification constant (in)
isComposite - The isComposite (in)
isAttributed - The isAttributed (in)
relAttrFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
originPrimaryKey - The originPrimaryKey (in)
destPrimaryKey - The destPrimaryKey (in)
originForeignKey - The originForeignKey (in)
destForeignKey - The destForeignKey (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRelationshipClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addRelationshipClass

void addRelationshipClass(IRelationshipClass relationshipClass)
                          throws IOException,
                                 AutomationException
Transfers ownership of a relationship class to this container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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