com.esri.arcgis.schematic
Interface ISchematicBuilderRule

All Superinterfaces:
Serializable
All Known Implementing Classes:
ISchematicBuilderRuleProxy, SchematicBuilderRule

public interface ISchematicBuilderRule
extends Serializable

Provides access to members that control the schematic builder rule.

Product Availability

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

See Also:
ISchematicRule, ISchematicBuilderRuleContainer, ISchematicBuilderRuleManager

Method Summary
 void alter(IUID pUID, IPropertySet propertySet)
          Changes the schematic builder rule with the new specified CLSID schematic builder rule and the new specified schematic builder rule PropertySet.
 void apply(ISchematicDiagram pSchematicDiagram, ITrackCancel cancelTracker)
          Applies the schematic builder rule on the specified schematic diagram.
 void delete()
          Deletes the schematic builder rule.
 IUID getCLSID()
          CLSID of the schematic builder rule.
 int getID()
          ID of the schematic builder rule.
 int getOrderNumber()
          Order number of the schematic builder rule.
 IPropertySet getPropertySet()
          PropertySet related to the schematic builder rule.
 ISchematicDiagramClass getSchematicDiagramClass()
          Schematic diagram class related to the schematic builder rule.
 boolean isActive()
          Indicates if the schematic builder rule is active.
 void setIsActive(boolean active)
          Indicates if the schematic builder rule is active.
 

Method Detail

getID

int getID()
          throws IOException,
                 AutomationException
ID of the schematic builder rule.

Product Availability

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

Returns:
The lRuleID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderRule.getCLSID()

setIsActive

void setIsActive(boolean active)
                 throws IOException,
                        AutomationException
Indicates if the schematic builder rule is active.

Product Availability

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

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

isActive

boolean isActive()
                 throws IOException,
                        AutomationException
Indicates if the schematic builder rule is active.

Product Availability

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

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

getOrderNumber

int getOrderNumber()
                   throws IOException,
                          AutomationException
Order number of the schematic builder rule.

Product Availability

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

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

getCLSID

IUID getCLSID()
              throws IOException,
                     AutomationException
CLSID of the schematic builder 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:
ISchematicBuilderRule.getID()

getPropertySet

IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
PropertySet related to the schematic builder 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.

alter

void alter(IUID pUID,
           IPropertySet propertySet)
           throws IOException,
                  AutomationException
Changes the schematic builder rule with the new specified CLSID schematic builder rule and the new specified schematic builder rule PropertySet.

Product Availability

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

Parameters:
pUID - A reference to a com.esri.arcgis.system.IUID (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.

getSchematicDiagramClass

ISchematicDiagramClass getSchematicDiagramClass()
                                                throws IOException,
                                                       AutomationException
Schematic diagram class related to the schematic builder 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.

delete

void delete()
            throws IOException,
                   AutomationException
Deletes the schematic builder rule.

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.

apply

void apply(ISchematicDiagram pSchematicDiagram,
           ITrackCancel cancelTracker)
           throws IOException,
                  AutomationException
Applies the schematic builder rule on the specified schematic diagram.

Product Availability

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

Parameters:
pSchematicDiagram - 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.