com.esri.arcgis.geodatabase
Interface IRelationshipClass2

All Superinterfaces:

IRelationshipClass, Serializable

All Known Subinterfaces:

IRelationshipClass3

All Known Implementing Classes:

AttributedRelationshipClass, IRelationshipClass2Proxy, IRelationshipClass3Proxy, MemoryRelationshipClass, RelationshipClass

public interface IRelationshipClass2
extends IRelationshipClass, Serializable

Provides access to members that get related object row pairs within a query filter specification.

Remarks

The IRelationshipClass2 interface extends the IRelationshipClass interface, providing methods to retrieve related object pairs from the relationship class where the matched object satisfies the conditions of a query filter.

Product Availability

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

See Also:

RelationshipClass, IRelationshipClassEvents, esriRelRole

Method Summary

IRelClassEnumRowPairs	getObjectsMatchingObjectArray(IArray srcObjectArray, IQueryFilter queryFilterAppliedToMatchingObjects, boolean returnAllObjectMatches) Gets rows pairs of objects that are related to the specified origin or destination object array, that also meet the query filter expression.
IRelClassEnumRowPairs	getObjectsMatchingObjectSetEx(ISet srcObjectSet, IQueryFilter queryFilterAppliedToMatchingObjects, boolean returnAllObjectMatches) Gets rows pairs of objects that are related to the specified origin or destination object set, that also meet the query filter expression.

Methods inherited from interface com.esri.arcgis.geodatabase.IRelationshipClass

addRelationshipRule, createRelationship, deleteRelationship, deleteRelationshipRule, deleteRelationshipsForObject, deleteRelationshipsForObjectSet, getBackwardPathLabel, getCardinality, getDestinationClass, getDestinationForeignKey, getDestinationPrimaryKey, getFeatureDataset, getForwardPathLabel, getNotification, getObjectsMatchingObjectSet, getObjectsRelatedToObject, getObjectsRelatedToObjectSet, getOriginClass, getOriginForeignKey, getOriginPrimaryKey, getRelationship, getRelationshipClassID, getRelationshipRules, getRelationshipsForObject, getRelationshipsForObjectSet, isAttributed, isComposite

Method Detail

getObjectsMatchingObjectSetEx

IRelClassEnumRowPairs getObjectsMatchingObjectSetEx(ISet srcObjectSet,
                                                    IQueryFilter queryFilterAppliedToMatchingObjects,
                                                    boolean returnAllObjectMatches)
                                                    throws IOException,
                                                           AutomationException

Gets rows pairs of objects that are related to the specified origin or destination object set, that also meet the query filter expression.

Remarks

The returnAllObjectMatches parameter indicates whether the first matching object or if all matching objects are returned. A value of True will return all object matches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

queryFilterAppliedToMatchingObjects - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

returnAllObjectMatches - The returnAllObjectMatches (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectsMatchingObjectArray

IRelClassEnumRowPairs getObjectsMatchingObjectArray(IArray srcObjectArray,
                                                    IQueryFilter queryFilterAppliedToMatchingObjects,
                                                    boolean returnAllObjectMatches)
                                                    throws IOException,
                                                           AutomationException

Gets rows pairs of objects that are related to the specified origin or destination object array, that also meet the query filter expression.

Remarks

The returnAllObjectMatches parameter indicates whether the first matching object or if all matching objects are returned. A value of True will return all object matches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

srcObjectArray - A reference to a com.esri.arcgis.system.IArray (in)

queryFilterAppliedToMatchingObjects - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

returnAllObjectMatches - The returnAllObjectMatches (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.