com.esri.arcgis.schematic
Interface ISchematicRule

All Superinterfaces:
Serializable
All Known Implementing Classes:
SchematicCollapseRelatedElementsRule, SchematicExpandLinksByAttributeRule, SchematicFeatureRemovalRule, SchematicNodeReductionRuleByFlow, SchematicNodeReductionRuleByPriority, SchematicRelationshipRule, SchematicRouteNodeReductionRule, SchematicSpatialQueryRule

public interface ISchematicRule
extends Serializable

Provides access to members that manage the schematic rule.

Product Availability

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

See Also:
ISchematicBuilderRule

Method Summary
 void alter(ISchematicDiagramClass schematicDiagramClass, IPropertySet propertySet)
          Changes the schematic rule for the specified schematic diagram class with the specified rule type PropertySet.
 void apply(ISchematicInMemoryDiagram inMemoryDiagram, ITrackCancel cancelTracker)
          Applies the schematic rule on the specified schematic in memory diagram.
 IUID getClassID()
          ClassID of the schematic rule.
 String getDescription()
          Description of the schematic rule.
 String getName()
          Name of the schematic rule.
 IPropertySet getPropertySet()
          PropertySet related to the schematic rule.
 ISchematicDiagramClass getSchematicDiagramClass()
          Schematic diagram class related to the schematic rule.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the schematic rule.

Product Availability

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

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicRule.getClassID()

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
Description of the schematic 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.

getClassID

IUID getClassID()
                throws IOException,
                       AutomationException
ClassID of the schematic rule.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicRule.getName()

getPropertySet

IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
PropertySet related to the schematic rule.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClass

ISchematicDiagramClass getSchematicDiagramClass()
                                                throws IOException,
                                                       AutomationException
Schematic diagram class related to the schematic rule.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alter

void alter(ISchematicDiagramClass schematicDiagramClass,
           IPropertySet propertySet)
           throws IOException,
                  AutomationException
Changes the schematic rule for the specified schematic diagram class with the specified rule type PropertySet.

Product Availability

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

Parameters:
schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

apply

void apply(ISchematicInMemoryDiagram inMemoryDiagram,
           ITrackCancel cancelTracker)
           throws IOException,
                  AutomationException
Applies the schematic rule on the specified schematic in memory diagram.

Product Availability

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

Parameters:
inMemoryDiagram - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryDiagram (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.