com.esri.arcgis.schematic
Interface ISchematicCollapseRelatedElementsRule

All Superinterfaces:
Serializable
All Known Implementing Classes:
SchematicCollapseRelatedElementsRule

public interface ISchematicCollapseRelatedElementsRule
extends Serializable

Provides access to members that manage the Collapse Related Elements rule.

Product Availability

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


Method Summary
 String getDescription()
          Description of the Schematic Collapse Related Elements rule.
 String getExtendedCriteriaName()
          Name of the extended criteria.
 String getNodeClassName()
          Name of the schematic node element class related to the Schematic Collapse Related Elements rule; that is, name of the schematic node element class to collapse.
 String getWhereClause()
          Where clause used on associated feature to filter the schematic elements to collapse.
 boolean isExtendedCriteriaUsed()
          Indicates if additional extended criteria is used.
 boolean isKeepVertices()
          Indicates if the Schematic Collapse Related Elements rule keeps the links vertices.
 void setDescription(String description)
          Description of the Schematic Collapse Related Elements rule.
 void setExtendedCriteriaName(String extendedCriteriaName)
          Name of the extended criteria.
 void setExtendedCriteriaUsed(boolean extendedCriteriaUsed)
          Indicates if additional extended criteria is used.
 void setKeepVertices(boolean keepVertices)
          Indicates if the Schematic Collapse Related Elements rule keeps the links vertices.
 void setNodeClassName(String nodeClassName)
          Name of the schematic node element class related to the Schematic Collapse Related Elements rule; that is, name of the schematic node element class to collapse.
 void setWhereClause(String whereClause)
          Where clause used on associated feature to filter the schematic elements to collapse.
 

Method Detail

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
Description of the Schematic Collapse Related Elements rule.

Product Availability

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

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

setDescription

void setDescription(String description)
                    throws IOException,
                           AutomationException
Description of the Schematic Collapse Related Elements rule.

Product Availability

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

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

getNodeClassName

String getNodeClassName()
                        throws IOException,
                               AutomationException
Name of the schematic node element class related to the Schematic Collapse Related Elements rule; that is, name of the schematic node element class to collapse.

Product Availability

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

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

setNodeClassName

void setNodeClassName(String nodeClassName)
                      throws IOException,
                             AutomationException
Name of the schematic node element class related to the Schematic Collapse Related Elements rule; that is, name of the schematic node element class to collapse.

Product Availability

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

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

isKeepVertices

boolean isKeepVertices()
                       throws IOException,
                              AutomationException
Indicates if the Schematic Collapse Related Elements rule keeps the links vertices.

Product Availability

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

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

setKeepVertices

void setKeepVertices(boolean keepVertices)
                     throws IOException,
                            AutomationException
Indicates if the Schematic Collapse Related Elements rule keeps the links vertices.

Product Availability

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

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

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException
Where clause used on associated feature to filter the schematic elements to collapse.

Product Availability

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

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

setWhereClause

void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException
Where clause used on associated feature to filter the schematic elements to collapse.

Product Availability

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

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

isExtendedCriteriaUsed

boolean isExtendedCriteriaUsed()
                               throws IOException,
                                      AutomationException
Indicates if additional extended criteria is used.

Product Availability

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

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

setExtendedCriteriaUsed

void setExtendedCriteriaUsed(boolean extendedCriteriaUsed)
                             throws IOException,
                                    AutomationException
Indicates if additional extended criteria is used.

Product Availability

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

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

getExtendedCriteriaName

String getExtendedCriteriaName()
                               throws IOException,
                                      AutomationException
Name of the extended criteria.

Product Availability

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

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

setExtendedCriteriaName

void setExtendedCriteriaName(String extendedCriteriaName)
                             throws IOException,
                                    AutomationException
Name of the extended criteria.

Product Availability

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

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