com.esri.arcgis.geodatabase
Class RelationshipRule

java.lang.Object
  com.esri.arcgis.geodatabase.RelationshipRule

All Implemented Interfaces:

IRelationshipRule, IRule, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class RelationshipRule
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRule, IRelationshipRule, IXMLSerialize, IPersistStream, IClone, Externalizable

ESRI relationship rule object.

Description

RelationshipRule coclass maintains properties associated with a relationship rule object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RelationshipRule()
Constructs a RelationshipRule using ArcGIS Engine.

RelationshipRule(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RelationshipRule theRelationshipRule = (RelationshipRule) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
int	getCategory() The name associated with the validation rule.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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.
String	getHelpstring() The helpstring associated with the validation rule.
int	getID() The ID of the validation rule.
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	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getType() The type associated with the validation rule.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCategory(int groupBitmap) The name associated with the validation rule.
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	setHelpstring(String helpstring) The helpstring associated with the validation rule.
void	setID(int iD) The ID of the validation rule.
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.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RelationshipRule

public RelationshipRule()
                 throws IOException,
                        UnknownHostException

Constructs a RelationshipRule using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RelationshipRule

public RelationshipRule(Object obj)
                 throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RelationshipRule theRelationshipRule = (RelationshipRule) obj;

Construct a RelationshipRule using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RelationshipRule.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getCategory

public int getCategory()
                throws IOException,
                       AutomationException

The name associated with the validation rule.

Description

Category sets the name associated with the rule. Not currently used by any ArcGIS application.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface IRule

Returns:

The groupBitmap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(int groupBitmap)
                 throws IOException,
                        AutomationException

The name associated with the validation rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCategory in interface IRule

Parameters:

groupBitmap - The groupBitmap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpstring

public String getHelpstring()
                     throws IOException,
                            AutomationException

The helpstring associated with the validation rule.

Description

Helpstring property sets the helpstring for the given rule. Not currently used by any ArcGIS application.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHelpstring in interface IRule

Returns:

The helpstring

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelpstring

public void setHelpstring(String helpstring)
                   throws IOException,
                          AutomationException

The helpstring associated with the validation rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHelpstring in interface IRule

Parameters:

helpstring - The helpstring (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws IOException,
                 AutomationException

The ID of the validation rule.

Description

ID property returns the id for the given rule.

Remarks

This property will always return -1 for rules in geodatabases created in versions of ArcGIS later than 9.3.1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getID in interface IRule

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int iD)
           throws IOException,
                  AutomationException

The ID of the validation rule.

Description

ID property sets the id for the given rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setID in interface IRule

Parameters:

iD - The iD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type associated with the validation rule.

Description

Type property returns the esriRuleType enumeration type of the given rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IRule

Returns:

A com.esri.arcgis.geodatabase.esriRuleType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationClassID

public 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

Specified by:

getDestinationClassID in interface IRelationshipRule

Returns:

The classID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationClassID

public 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

Specified by:

setDestinationClassID in interface IRelationshipRule

Parameters:

classID - The classID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationSubtypeCode

public 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

Specified by:

getDestinationSubtypeCode in interface IRelationshipRule

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationSubtypeCode

public 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

Specified by:

setDestinationSubtypeCode in interface IRelationshipRule

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationMinimumCardinality

public 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

Specified by:

getDestinationMinimumCardinality in interface IRelationshipRule

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationMinimumCardinality

public 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

Specified by:

setDestinationMinimumCardinality in interface IRelationshipRule

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationMaximumCardinality

public 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

Specified by:

getDestinationMaximumCardinality in interface IRelationshipRule

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationMaximumCardinality

public 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

Specified by:

setDestinationMaximumCardinality in interface IRelationshipRule

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginClassID

public 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

Specified by:

getOriginClassID in interface IRelationshipRule

Returns:

The classID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOriginClassID

public 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

Specified by:

setOriginClassID in interface IRelationshipRule

Parameters:

classID - The classID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginSubtypeCode

public 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

Specified by:

getOriginSubtypeCode in interface IRelationshipRule

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOriginSubtypeCode

public 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

Specified by:

setOriginSubtypeCode in interface IRelationshipRule

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginMinimumCardinality

public 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

Specified by:

getOriginMinimumCardinality in interface IRelationshipRule

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOriginMinimumCardinality

public 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

Specified by:

setOriginMinimumCardinality in interface IRelationshipRule

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginMaximumCardinality

public 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

Specified by:

getOriginMaximumCardinality in interface IRelationshipRule

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOriginMaximumCardinality

public 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

Specified by:

setOriginMaximumCardinality in interface IRelationshipRule

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException