com.esri.arcgis.geodatabase
Interface IDERelationshipClassEx

All Superinterfaces:

Serializable

All Known Subinterfaces:

IDERelationshipClassEx2

All Known Implementing Classes:

DERelationshipClass

public interface IDERelationshipClassEx
extends Serializable

Provides access to members that describe relationship class data elements.

Product Availability

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

Method Summary

String	getBackwardPathLabel() The backward path label for the relationship class.
int	getCardinality() The cardinality for the relationship class.
int	getClassKey() Class key used for the relationship class (Undefined, ClassID or Class Code).
IArray	getDestinationClassKeys() An array with the relationship class keys (IGPRelationshipClassKey) of the destination classes.
IStringArray	getDestinationClassNames() The names of the destination classes.
String	getForwardPathLabel() The forward path label for the relationship class.
int	getKeyType() Key type for the relationship class (Dual or Single).
int	getNotification() The notification direction for the relationship class.
IArray	getOriginClassKeys() An array with the relationship class keys (IGPRelationshipClassKey) of the origin classes.
IStringArray	getOriginClassNames() The names of the origin classes.
IArray	getRelationshipRules() The relationship rules that apply to this relationship class.
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.
boolean	isReflexive() Indicates if origin and destination sets intersect.
void	setBackwardPathLabel(String label) The backward path label for the relationship class.
void	setCardinality(int relCardinality) The cardinality for the relationship class.
void	setClassKey(int classKey) Class key used for the relationship class (Undefined, ClassID or Class Code).
void	setDestinationClassKeysByRef(IArray destinationClassNames) An array with the relationship class keys (IGPRelationshipClassKey) of the destination classes.
void	setDestinationClassNamesByRef(IStringArray destinationClassNames) The names of the destination classes.
void	setForwardPathLabel(String label) The forward path label for the relationship class.
void	setIsAttributed(boolean attributed) Indicates if the relationships in this relationship class have attributes.
void	setIsComposite(boolean composite) Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.
void	setIsReflexive(boolean reflexive) Indicates if origin and destination sets intersect.
void	setKeyType(int keyType) Key type for the relationship class (Dual or Single).
void	setNotification(int notification) The notification direction for the relationship class.
void	setOriginClassKeysByRef(IArray originClassKeys) An array with the relationship class keys (IGPRelationshipClassKey) of the origin classes.
void	setOriginClassNamesByRef(IStringArray originClassNames) The names of the origin classes.
void	setRelationshipRulesByRef(IArray rules) The relationship rules that apply to this relationship class.

Method Detail

getOriginClassNames

IStringArray getOriginClassNames()
                                 throws IOException,
                                        AutomationException

The names of the origin classes.

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.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOriginClassNamesByRef

void setOriginClassNamesByRef(IStringArray originClassNames)
                              throws IOException,
                                     AutomationException

The names of the origin classes.

Product Availability

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

Parameters:

originClassNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationClassNames

IStringArray getDestinationClassNames()
                                      throws IOException,
                                             AutomationException

The names of the destination classes.

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.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationClassNamesByRef

void setDestinationClassNamesByRef(IStringArray destinationClassNames)
                                   throws IOException,
                                          AutomationException

The names of the destination classes.

Product Availability

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

Parameters:

destinationClassNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginClassKeys

IArray getOriginClassKeys()
                          throws IOException,
                                 AutomationException

An array with the relationship class keys (IGPRelationshipClassKey) of the origin classes.

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.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOriginClassKeysByRef

void setOriginClassKeysByRef(IArray originClassKeys)
                             throws IOException,
                                    AutomationException

An array with the relationship class keys (IGPRelationshipClassKey) of the origin classes.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationClassKeys

IArray getDestinationClassKeys()
                               throws IOException,
                                      AutomationException

An array with the relationship class keys (IGPRelationshipClassKey) of the destination classes.

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.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationClassKeysByRef

void setDestinationClassKeysByRef(IArray destinationClassNames)
                                  throws IOException,
                                         AutomationException

An array with the relationship class keys (IGPRelationshipClassKey) of the destination classes.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyType

int getKeyType()
               throws IOException,
                      AutomationException

Key type for the relationship class (Dual or Single).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriRelKeyType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeyType

void setKeyType(int keyType)
                throws IOException,
                       AutomationException

Key type for the relationship class (Dual or Single).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

keyType - A com.esri.arcgis.geodatabase.esriRelKeyType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassKey

int getClassKey()
                throws IOException,
                       AutomationException

Class key used for the relationship class (Undefined, ClassID or Class Code).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriRelClassKey constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassKey

void setClassKey(int classKey)
                 throws IOException,
                        AutomationException

Class key used for the relationship class (Undefined, ClassID or Class Code).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

classKey - A com.esri.arcgis.geodatabase.esriRelClassKey constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReflexive

boolean isReflexive()
                    throws IOException,
                           AutomationException

Indicates if origin and destination sets intersect.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The reflexive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsReflexive

void setIsReflexive(boolean reflexive)
                    throws IOException,
                           AutomationException

Indicates if origin and destination sets intersect.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

reflexive - The reflexive (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getForwardPathLabel

String getForwardPathLabel()
                           throws IOException,
                                  AutomationException

The forward path label for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setForwardPathLabel

void setForwardPathLabel(String label)
                         throws IOException,
                                AutomationException

The forward path label for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackwardPathLabel

String getBackwardPathLabel()
                            throws IOException,
                                   AutomationException

The backward path label for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackwardPathLabel

void setBackwardPathLabel(String label)
                          throws IOException,
                                 AutomationException

The backward path label for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCardinality

int getCardinality()
                   throws IOException,
                          AutomationException

The cardinality for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriRelCardinality constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCardinality

void setCardinality(int relCardinality)
                    throws IOException,
                           AutomationException

The cardinality for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

relCardinality - A com.esri.arcgis.geodatabase.esriRelCardinality constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNotification

int getNotification()
                    throws IOException,
                           AutomationException

The notification direction for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriRelNotification constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNotification

void setNotification(int notification)
                     throws IOException,
                            AutomationException

The notification direction for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

notification - A com.esri.arcgis.geodatabase.esriRelNotification constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAttributed

boolean isAttributed()
                     throws IOException,
                            AutomationException

Indicates if the relationships in this relationship class have attributes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The attributed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsAttributed

void setIsAttributed(boolean attributed)
                     throws IOException,
                            AutomationException

Indicates if the relationships in this relationship class have attributes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

attributed - The attributed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isComposite

boolean isComposite()
                    throws IOException,
                           AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The composite

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsComposite

void setIsComposite(boolean composite)
                    throws IOException,
                           AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

composite - The composite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipRules

IArray getRelationshipRules()
                            throws IOException,
                                   AutomationException

The relationship rules that apply to this relationship class.

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.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelationshipRulesByRef

void setRelationshipRulesByRef(IArray rules)
                               throws IOException,
                                      AutomationException

The relationship rules that apply to this relationship class.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.