com.esri.arcgis.geodatabase
Interface IRule

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IAttributeRule, IConnectivityRule, IEdgeConnectivityRule, IJunctionConnectivityRule, IJunctionConnectivityRule2, IRelationshipRule

All Known Implementing Classes:

AttributeRule, EdgeConnectivityRule, IAttributeRuleProxy, IConnectivityRuleProxy, IEdgeConnectivityRuleProxy, IJunctionConnectivityRule2Proxy, IJunctionConnectivityRuleProxy, IRelationshipRuleProxy, IRuleProxy, JunctionConnectivityRule, RelationshipRule, TopologyRule

public interface IRule

extends java.io.Serializable

Provides access to members that return information about rules.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

IRule interface is used to establish rules that object classes must adhere to in order for the map to be considered a valid map. There are four types of rules that can be created: Attribute Domains, Connectivity Rules, Relationship Rules, and Custom Rules.

When To Use

IRule is the interface on a Rule abstract class used to get and set the properties on one of the three types of rule objects (Attribute Rule, Relationship Rule, Connectivity Rule). For example, you can set/get the category, helpstring, and id for the rule and you can also get the esriRuleType from a esriRuleType object. You would use IRule when you want to create rules for a particular object class so that it can be validated.

Method Summary

int	getCategory() The name associated with the validation rule.
java.lang.String	getHelpstring() The helpstring associated with the validation rule.
int	getID() The ID of the validation rule.
int	getType() The type associated with the validation rule.
void	setCategory(int groupBitmap) The name associated with the validation rule.
void	setHelpstring(java.lang.String helpstring) The helpstring associated with the validation rule.
void	setID(int iD) The ID of the validation rule.

Method Detail

getCategory

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

The name associated with the validation rule.

Supported Platforms

Windows, Solaris, Linux

Description

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

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.

Supported Platforms

Windows, Solaris, Linux

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.

Supported Platforms

Windows, Solaris, Linux

Description

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

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.

Supported Platforms

Windows, Solaris, Linux

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.

Supported Platforms

Windows, Solaris, Linux

Description

ID property returns the id for the given rule.

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.

Supported Platforms

Windows, Solaris, Linux

Description

ID property sets the id for the given rule.

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.

Supported Platforms

Windows, Solaris, Linux

Description

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

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.