com.esri.arcgis.geodatabase

Interface IRelationshipClass

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IRelationshipClass2, IRelationshipClass3, IRelationshipClass4

All Known Implementing Classes:

AttributedRelationshipClass, IRelationshipClass2Proxy, IRelationshipClass3Proxy, IRelationshipClass4Proxy, IRelationshipClassProxy, MemoryRelationshipClass, RelationshipClass

public interface IRelationshipClass
extends java.io.Serializable

COM Interface 'IRelationshipClass'. Generated 9/21/2023 10:01:46 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to members that return information about the relationship class, create relationships, relationship rules and get related objects.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID22b00693_8895_11d2_8a0d_006097aff44e
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	addRelationshipRule(IRule rule) Adds a relationship rule to this relationship class.
IRelationship	createRelationship(IObject originObject, IObject destinationObject) Creates a new relationship between the two specified objects.
void	deleteRelationship(IObject originObject, IObject destinationObject) Deletes the relationship that associates the two specified objects.
void	deleteRelationshipRule(IRule rule) Deletes a relationship rule from this relationship class.
void	deleteRelationshipsForObject(IObject anObject) Deletes all relationships that apply to a specified object.
void	deleteRelationshipsForObjectSet(ISet anObjectSet) Deletes all relationships that apply to the specified origin or destination object set.
java.lang.String	getBackwardPathLabel() The backward path label for the relationship class.
int	getCardinality() The cardinality for the relationship class.
IObjectClass	getDestinationClass() The destination object class.
java.lang.String	getDestinationForeignKey() The relationship destination foreign Key.
java.lang.String	getDestinationPrimaryKey() The relationship destination primary Key.
IFeatureDataset	getFeatureDataset() The feature dataset, if any, to which this relationship class belongs.
java.lang.String	getForwardPathLabel() The forward path label for the relationship class.
int	getNotification() The notification direction for the relationship class.
IRelClassEnumRowPairs	getObjectsMatchingObjectSet(ISet srcObjectSet) Gets rows pairs of objects that are related to the specified origin or destination object set.
ISet	getObjectsRelatedToObject(IObject anObject) Gets the objects that are related to the specified object.
ISet	getObjectsRelatedToObjectSet(ISet anObjectSet) Gets the objects that are related to the specified origin or destination object set.
IObjectClass	getOriginClass() The origin object class.
java.lang.String	getOriginForeignKey() The relationship origin foreign Key.
java.lang.String	getOriginPrimaryKey() The relationship origin primary Key.
IRelationship	getRelationship(IObject originObject, IObject destinationObject) Get the relationship that associates the two specified objects.
int	getRelationshipClassID() The relationship class ID.
IEnumRule	getRelationshipRules() The relationship rules that apply to this relationship class.
IEnumRelationship	getRelationshipsForObject(IObject anObject) Get all relationships that apply to a specified object.
IEnumRelationship	getRelationshipsForObjectSet(ISet anObjectSet) Get all relationships that apply to the specified origin or destination object set.
boolean	isAttributed() Indicates if the relationships in this relationship class have attributes.
boolean	isComposite() Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.

Field Detail

IID22b00693_8895_11d2_8a0d_006097aff44e

static final int IID22b00693_8895_11d2_8a0d_006097aff44e

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getOriginPrimaryKey

java.lang.String getOriginPrimaryKey()
                              throws java.io.IOException,
                                     AutomationException

The relationship origin primary Key.

Returns:

The relOrigPKey

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationPrimaryKey

java.lang.String getDestinationPrimaryKey()
                                   throws java.io.IOException,
                                          AutomationException

The relationship destination primary Key.

Returns:

The relDestPKey

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginForeignKey

java.lang.String getOriginForeignKey()
                              throws java.io.IOException,
                                     AutomationException

The relationship origin foreign Key.

Returns:

The relOrigFKey

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationForeignKey

java.lang.String getDestinationForeignKey()
                                   throws java.io.IOException,
                                          AutomationException

The relationship destination foreign Key.

Returns:

The relDestFKey

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipClassID

int getRelationshipClassID()
                    throws java.io.IOException,
                           AutomationException

The relationship class ID.

Returns:

The relClassId

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginClass

IObjectClass getOriginClass()
                     throws java.io.IOException,
                            AutomationException

The origin object class.

Returns:

A reference to a com.esri.arcgis.geodatabase.IObjectClass

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationClass

IObjectClass getDestinationClass()
                          throws java.io.IOException,
                                 AutomationException

The destination object class.

Returns:

A reference to a com.esri.arcgis.geodatabase.IObjectClass

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureDataset

IFeatureDataset getFeatureDataset()
                           throws java.io.IOException,
                                  AutomationException

The feature dataset, if any, to which this relationship class belongs.

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureDataset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getForwardPathLabel

java.lang.String getForwardPathLabel()
                              throws java.io.IOException,
                                     AutomationException

The forward path label for the relationship class.

Returns:

The forwardLabel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackwardPathLabel

java.lang.String getBackwardPathLabel()
                               throws java.io.IOException,
                                      AutomationException

The backward path label for the relationship class.

Returns:

The backwardLabel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCardinality

int getCardinality()
            throws java.io.IOException,
                   AutomationException

The cardinality for the relationship class.

Returns:

A com.esri.arcgis.geodatabase.esriRelCardinality constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNotification

int getNotification()
             throws java.io.IOException,
                    AutomationException

The notification direction for the relationship class.

Returns:

A com.esri.arcgis.geodatabase.esriRelNotification constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAttributed

boolean isAttributed()
              throws java.io.IOException,
                     AutomationException

Indicates if the relationships in this relationship class have attributes.

Returns:

The isAttributed

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isComposite

boolean isComposite()
             throws java.io.IOException,
                    AutomationException

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

Returns:

The isComposite

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRelationship

IRelationship createRelationship(IObject originObject,
                                 IObject destinationObject)
                          throws java.io.IOException,
                                 AutomationException

Creates a new relationship between the two specified objects.

Parameters:

originObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

destinationObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRelationship

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationship

IRelationship getRelationship(IObject originObject,
                              IObject destinationObject)
                       throws java.io.IOException,
                              AutomationException

Get the relationship that associates the two specified objects.

Parameters:

originObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

destinationObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRelationship

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteRelationship

void deleteRelationship(IObject originObject,
                        IObject destinationObject)
                 throws java.io.IOException,
                        AutomationException

Deletes the relationship that associates the two specified objects.

Parameters:

originObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

destinationObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectsRelatedToObject

ISet getObjectsRelatedToObject(IObject anObject)
                        throws java.io.IOException,
                               AutomationException

Gets the objects that are related to the specified object.

Parameters:

anObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

A reference to a com.esri.arcgis.system.ISet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipsForObject

IEnumRelationship getRelationshipsForObject(IObject anObject)
                                     throws java.io.IOException,
                                            AutomationException

Get all relationships that apply to a specified object.

Parameters:

anObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumRelationship

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteRelationshipsForObject

void deleteRelationshipsForObject(IObject anObject)
                           throws java.io.IOException,
                                  AutomationException

Deletes all relationships that apply to a specified object.

Parameters:

anObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectsRelatedToObjectSet

ISet getObjectsRelatedToObjectSet(ISet anObjectSet)
                           throws java.io.IOException,
                                  AutomationException

Gets the objects that are related to the specified origin or destination object set.

Parameters:

anObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

Returns:

A reference to a com.esri.arcgis.system.ISet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipsForObjectSet

IEnumRelationship getRelationshipsForObjectSet(ISet anObjectSet)
                                        throws java.io.IOException,
                                               AutomationException

Get all relationships that apply to the specified origin or destination object set.

Parameters:

anObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumRelationship

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectsMatchingObjectSet

IRelClassEnumRowPairs getObjectsMatchingObjectSet(ISet srcObjectSet)
                                           throws java.io.IOException,
                                                  AutomationException

Gets rows pairs of objects that are related to the specified origin or destination object set.

Parameters:

srcObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRelClassEnumRowPairs

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteRelationshipsForObjectSet

void deleteRelationshipsForObjectSet(ISet anObjectSet)
                              throws java.io.IOException,
                                     AutomationException

Deletes all relationships that apply to the specified origin or destination object set.

Parameters:

anObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipRules

IEnumRule getRelationshipRules()
                        throws java.io.IOException,
                               AutomationException

The relationship rules that apply to this relationship class.

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumRule

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addRelationshipRule

void addRelationshipRule(IRule rule)
                  throws java.io.IOException,
                         AutomationException

Adds a relationship rule to this relationship class.

Parameters:

rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteRelationshipRule

void deleteRelationshipRule(IRule rule)
                     throws java.io.IOException,
                            AutomationException

Deletes a relationship rule from this relationship class.

Parameters:

rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.