com.esri.arcgis.geodatabase

Class AttributeRule

java.lang.Object

com.esri.arcgis.geodatabase.AttributeRule

All Implemented Interfaces:

IAttributeRule, IRule, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class AttributeRule
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRule, IAttributeRule

COM Class 'AttributeRule'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Esri attribute rule object.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geodatabase.IAttributeRule

IID, IID9ed62772_475d_11d2_9932_0000f80372b4, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IRule

IID236f4de4_4761_11d2_9932_0000f80372b4

Constructor Summary

Constructors

Constructor and Description
AttributeRule() Constructs a AttributeRule using ArcGIS Engine.
AttributeRule(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. AttributeRule theAttributeRule = (AttributeRule) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
int	getCategory() The name associated with the validation rule.
static java.lang.String	getClsid() getClsid.
java.lang.String	getDomainName() The domain name associated with the attribute rule.
java.lang.String	getFieldName() The field name associated with the attribute rule.
java.lang.String	getHelpstring() The helpstring associated with the validation rule.
int	getID() The ID of the validation rule.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
int	getSubtypeCode() The subtype code.
int	getType() The type associated with the validation rule.
int	hashCode() the hashcode for this object
void	release() Release this COM object reference
void	setCategory(int groupBitmap) The name associated with the validation rule.
void	setDomainName(java.lang.String name) The domain name associated with the attribute rule.
void	setFieldName(java.lang.String name) The field name associated with the attribute rule.
void	setHelpstring(java.lang.String helpstring) The helpstring associated with the validation rule.
void	setID(int iD) The ID of the validation rule.
void	setSubtypeCode(int value) The subtype code.
boolean	validate(IRow row, java.lang.String[] errorMessage) Validates the rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeRule

public AttributeRule()
              throws java.io.IOException,
                     java.net.UnknownHostException

Constructs a AttributeRule using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AttributeRule

public AttributeRule(java.lang.Object obj)
              throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getCategory

public int getCategory()
                throws java.io.IOException,
                       AutomationException

The name associated with the validation rule.

Specified by:

getCategory in interface IRule

Returns:

The groupBitmap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(int groupBitmap)
                 throws java.io.IOException,
                        AutomationException

The name associated with the validation rule.

Specified by:

setCategory in interface IRule

Parameters:

groupBitmap - The groupBitmap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpstring

public java.lang.String getHelpstring()
                               throws java.io.IOException,
                                      AutomationException

The helpstring associated with the validation rule.

Specified by:

getHelpstring in interface IRule

Returns:

The helpstring

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHelpstring

public void setHelpstring(java.lang.String helpstring)
                   throws java.io.IOException,
                          AutomationException

The helpstring associated with the validation rule.

Specified by:

setHelpstring in interface IRule

Parameters:

helpstring - The helpstring (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws java.io.IOException,
                 AutomationException

The ID of the validation rule.

Specified by:

getID in interface IRule

Returns:

The iD

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int iD)
           throws java.io.IOException,
                  AutomationException

The ID of the validation rule.

Specified by:

setID in interface IRule

Parameters:

iD - The iD (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The type associated with the validation rule.

Specified by:

getType in interface IRule

Returns:

A com.esri.arcgis.geodatabase.esriRuleType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDomainName

public java.lang.String getDomainName()
                               throws java.io.IOException,
                                      AutomationException

The domain name associated with the attribute rule.

Specified by:

getDomainName in interface IAttributeRule

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDomainName

public void setDomainName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

The domain name associated with the attribute rule.

Specified by:

setDomainName in interface IAttributeRule

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldName

public java.lang.String getFieldName()
                              throws java.io.IOException,
                                     AutomationException

The field name associated with the attribute rule.

Specified by:

getFieldName in interface IAttributeRule

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldName

public void setFieldName(java.lang.String name)
                  throws java.io.IOException,
                         AutomationException

The field name associated with the attribute rule.

Specified by:

setFieldName in interface IAttributeRule

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubtypeCode

public int getSubtypeCode()
                   throws java.io.IOException,
                          AutomationException

The subtype code.

Specified by:

getSubtypeCode in interface IAttributeRule

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubtypeCode

public void setSubtypeCode(int value)
                    throws java.io.IOException,
                           AutomationException

The subtype code.

Specified by:

setSubtypeCode in interface IAttributeRule

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validate

public boolean validate(IRow row,
                        java.lang.String[] errorMessage)
                 throws java.io.IOException,
                        AutomationException

Validates the rule.

Specified by:

validate in interface IAttributeRule

Parameters:

row - A reference to a com.esri.arcgis.geodatabase.IRow (in)

errorMessage - The errorMessage (out: use single element array)

Returns:

The isValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.