com.esri.arcgis.geodatabase
Interface IRepresentationRules

All Superinterfaces:
Serializable
All Known Implementing Classes:
RepresentationRules

public interface IRepresentationRules
extends Serializable

Provides access to members that supply information about the representation rules of a feature class representation.

Remarks

IRepresentationRules interface provides access to the members of the representation rules collection on a representation class. This interface can be used to add, remove or modify rules in representation rules collection.

Use Reset and Next methods to reset the cursor to the beginning of the collection and to access the next rule along with its unique ID. While ID starts with 1 and is useful to identify the rule, the index starts with 0 and determines the position of the rule in the collection. The RuleID field in the feature class attribute table contains this ID value.

Add method adds a new rule to the collection. If no name, index and representation rule are defined, the method will automatically assign default values including a unique rule ID. It is the responsibility of the user to modify the rules and attribute features with the representation rule information.

Product Availability

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


Method Summary
 int add(IRepresentationRule repRule)
          Adds a new representation rule to the collection.
 boolean exists(int iD)
          Checks whether the given representation rule exists in the collection.
 int getIndex(int iD)
          Index of a representation rule indicated by its ID.
 String getName(int iD)
          Name of a representation rule indicated by its ID.
 IRepresentationRule getRule(int iD)
          The representation rule indicated by its ID.
 void next(int[] iD, IRepresentationRule[] repRule)
          Returns the next representation rule in the enumeration.
 void remove(int iD)
          Removes the representation rule identified by its ID.
 void removeAll()
          Removes all the representation rules from the collection.
 void reset()
          Resets the representation rule enumeration to the beginning.
 void setIndex(int iD, int index)
          Index of a representation rule indicated by its ID.
 void setName(int iD, String name)
          Name of a representation rule indicated by its ID.
 void setRule(int iD, IRepresentationRule repRule)
          The representation rule indicated by its ID.
 

Method Detail

getName

String getName(int iD)
               throws IOException,
                      AutomationException
Name of a representation rule indicated by its ID.

Product Availability

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

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

setName

void setName(int iD,
             String name)
             throws IOException,
                    AutomationException
Name of a representation rule indicated by its ID.

Product Availability

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

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

getIndex

int getIndex(int iD)
             throws IOException,
                    AutomationException
Index of a representation rule indicated by its ID.

Product Availability

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

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

setIndex

void setIndex(int iD,
              int index)
              throws IOException,
                     AutomationException
Index of a representation rule indicated by its ID.

Product Availability

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

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

reset

void reset()
           throws IOException,
                  AutomationException
Resets the representation rule enumeration to the beginning.

Product Availability

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

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

next

void next(int[] iD,
          IRepresentationRule[] repRule)
          throws IOException,
                 AutomationException
Returns the next representation rule in the enumeration.

Remarks

Call Reset method before calling Next method as this will take the rules collection to the beginning.

Product Availability

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

Parameters:
iD - The iD (out: use single element array)
repRule - A reference to a com.esri.arcgis.display.IRepresentationRule (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRule

IRepresentationRule getRule(int iD)
                            throws IOException,
                                   AutomationException
The representation rule indicated by its ID.

Product Availability

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

Parameters:
iD - The iD (in)
Returns:
A reference to a com.esri.arcgis.display.IRepresentationRule
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRule

void setRule(int iD,
             IRepresentationRule repRule)
             throws IOException,
                    AutomationException
The representation rule indicated by its ID.

Product Availability

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

Parameters:
iD - The iD (in)
repRule - A reference to a com.esri.arcgis.display.IRepresentationRule (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

int add(IRepresentationRule repRule)
        throws IOException,
               AutomationException
Adds a new representation rule to the collection.

Product Availability

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

Parameters:
repRule - A reference to a com.esri.arcgis.display.IRepresentationRule (in)
Returns:
The iD
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

void remove(int iD)
            throws IOException,
                   AutomationException
Removes the representation rule identified by its ID.

Product Availability

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

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

removeAll

void removeAll()
               throws IOException,
                      AutomationException
Removes all the representation rules from the collection.

Remarks

Use RemoveAll method when you want to remove all representation rule items present in a representation rules collection.

This method must be used with care as once it is used, the representation rules object will become empty and it is the responsibility of the developer to create new representation rule(s) to add to the rules collection. Add method can be used to add new rule(s)

Product Availability

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

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

exists

boolean exists(int iD)
               throws IOException,
                      AutomationException
Checks whether the given representation rule exists in the collection.

Remarks

Exists method can be used to check for the availability of a specific representation rule within a RepresentationRules object before assigning it to a feature representation.

Product Availability

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

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