com.esri.arcgis.geodatabase
Interface IRelationshipRule

All Superinterfaces:
IRule, Serializable
All Known Implementing Classes:
RelationshipRule

public interface IRelationshipRule
extends IRule, Serializable

Provides access to members that supply information about, modify and manage relationship rules.

Description

The IRelationshipRule interface provides properties for setting up a and managing a relationship rule. Relationship classes can be provided with relationship rules to control how which object subtypes from the origin class can be related to which object subtypes in the destination class. They can also be used to specify a valid cardinality range for all permissable subtype pairs.

Product Availability

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


Method Summary
 int getDestinationClassID()
          The ID of the destination ObjectClass.
 int getDestinationMaximumCardinality()
          The maximum cardinality value of the destination ObjectClass.
 int getDestinationMinimumCardinality()
          The minimum cardinality value of the destination ObjectClass.
 int getDestinationSubtypeCode()
          The subtype value of the destination ObjectClass.
 int getOriginClassID()
          The ID of the origin ObjectClass.
 int getOriginMaximumCardinality()
          The maximum cardinality value of the origin ObjectClass.
 int getOriginMinimumCardinality()
          The minimum cardinality value of the origin ObjectClass.
 int getOriginSubtypeCode()
          The subtype value of the origin ObjectClass.
 void setDestinationClassID(int classID)
          The ID of the destination ObjectClass.
 void setDestinationMaximumCardinality(int value)
          The maximum cardinality value of the destination ObjectClass.
 void setDestinationMinimumCardinality(int value)
          The minimum cardinality value of the destination ObjectClass.
 void setDestinationSubtypeCode(int value)
          The subtype value of the destination ObjectClass.
 void setOriginClassID(int classID)
          The ID of the origin ObjectClass.
 void setOriginMaximumCardinality(int value)
          The maximum cardinality value of the origin ObjectClass.
 void setOriginMinimumCardinality(int value)
          The minimum cardinality value of the origin ObjectClass.
 void setOriginSubtypeCode(int value)
          The subtype value of the origin ObjectClass.
 
Methods inherited from interface com.esri.arcgis.geodatabase.IRule
getCategory, getHelpstring, getID, getType, setCategory, setHelpstring, setID
 

Method Detail

getDestinationClassID

int getDestinationClassID()
                          throws IOException,
                                 AutomationException
The ID of the destination ObjectClass.

Description


Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDestinationClassID

void setDestinationClassID(int classID)
                           throws IOException,
                                  AutomationException
The ID of the destination ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDestinationSubtypeCode

int getDestinationSubtypeCode()
                              throws IOException,
                                     AutomationException
The subtype value of the destination ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDestinationSubtypeCode

void setDestinationSubtypeCode(int value)
                               throws IOException,
                                      AutomationException
The subtype value of the destination ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDestinationMinimumCardinality

int getDestinationMinimumCardinality()
                                     throws IOException,
                                            AutomationException
The minimum cardinality value of the destination ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDestinationMinimumCardinality

void setDestinationMinimumCardinality(int value)
                                      throws IOException,
                                             AutomationException
The minimum cardinality value of the destination ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDestinationMaximumCardinality

int getDestinationMaximumCardinality()
                                     throws IOException,
                                            AutomationException
The maximum cardinality value of the destination ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDestinationMaximumCardinality

void setDestinationMaximumCardinality(int value)
                                      throws IOException,
                                             AutomationException
The maximum cardinality value of the destination ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOriginClassID

int getOriginClassID()
                     throws IOException,
                            AutomationException
The ID of the origin ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOriginClassID

void setOriginClassID(int classID)
                      throws IOException,
                             AutomationException
The ID of the origin ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOriginSubtypeCode

int getOriginSubtypeCode()
                         throws IOException,
                                AutomationException
The subtype value of the origin ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOriginSubtypeCode

void setOriginSubtypeCode(int value)
                          throws IOException,
                                 AutomationException
The subtype value of the origin ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOriginMinimumCardinality

int getOriginMinimumCardinality()
                                throws IOException,
                                       AutomationException
The minimum cardinality value of the origin ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOriginMinimumCardinality

void setOriginMinimumCardinality(int value)
                                 throws IOException,
                                        AutomationException
The minimum cardinality value of the origin ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOriginMaximumCardinality

int getOriginMaximumCardinality()
                                throws IOException,
                                       AutomationException
The maximum cardinality value of the origin ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOriginMaximumCardinality

void setOriginMaximumCardinality(int value)
                                 throws IOException,
                                        AutomationException
The maximum cardinality value of the origin ObjectClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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