com.esri.arcgis.schematic
Interface ISchematicRule

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicRuleProxy

public interface ISchematicRule
extends Serializable

Provides access to members that manage the rule type.

Product Availability

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

See Also:

ISchematicBuilderRule

Method Summary

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

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the rule type.

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 rule type.

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 rule type.

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 rule type.

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 rule type.

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 rule type 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(ISchematicDiagram schematicDiagram,
           ITrackCancel cancelTracker)
           throws IOException,
                  AutomationException

Applies the rule type on the specified schematic diagram.

Product Availability

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

Parameters:

schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.