com.esri.arcgis.geodatabase
Interface IRule

All Superinterfaces:
Serializable
All Known Subinterfaces:
IAttributeRule, IConnectivityRule, IEdgeConnectivityRule, IJunctionConnectivityRule, IJunctionConnectivityRule2, IRelationshipRule
All Known Implementing Classes:
AttributeRule, EdgeConnectivityRule, JunctionConnectivityRule, RelationshipRule, TopologyRule

public interface IRule
extends Serializable

Provides access to members that return information about rules.

Description

The IRule interface is used to configure and access rules that object classes must adhere to be successfully validated. There are four types of rules that can be created: attribute rules, connectivity rules (edge and junction), relationship rules, and topology rules.

When To Use

The IRule interface is used to get and set the common properties for all rule types. For example, you can set or get the category, help string, and ID for the rule and you can also get an esriRuleType value, representing the rule's type. You would use IRule when you want to create rules for a particular object class so that it can be validated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getCategory()
          The name associated with the validation rule.
 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(String helpstring)
          The helpstring associated with the validation rule.
 void setID(int iD)
          The ID of the validation rule.
 

Method Detail

getCategory

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

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

setCategory

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

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

getHelpstring

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

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

setHelpstring

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

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

getID

int getID()
          throws IOException,
                 AutomationException
The ID of the validation rule.

Description

ID property returns the id for the given rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setID

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

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

getType

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

Returns:
A com.esri.arcgis.geodatabase.esriRuleType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.