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 manage the schematic builder rule.

Product Availability

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

See Also:

ISchematicRule, ISchematicBuilderRuleContainer, com.esri.arcgis.schematic.ISchematicBuilderRuleManager

Method Summary

void	delete() Deletes the schematic builder rule.
int	getOrderNumber() Order number of the schematic builder rule.
ISchematicDiagramClass	getSchematicDiagramClass() Schematic diagram class the schematic builder rule belongs to.
ISchematicRule	getSchematicRule() Schematic rule associated to the schematic builder rule.
boolean	isActive() Indicates whether or not the schematic builder rule is active.
void	setIsActive(boolean active) Indicates whether or not the schematic builder rule is active.
void	setSchematicRuleByRef(ISchematicRule schematicRule) Schematic rule associated to the schematic builder rule.

Method Detail

isActive

boolean isActive()
                 throws IOException,
                        AutomationException

Indicates whether or not 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.

setIsActive

void setIsActive(boolean active)
                 throws IOException,
                        AutomationException

Indicates whether or not 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.

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.

getSchematicRule

ISchematicRule getSchematicRule()
                                throws IOException,
                                       AutomationException

Schematic rule associated 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.ISchematicRule

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicRuleByRef

void setSchematicRuleByRef(ISchematicRule schematicRule)
                           throws IOException,
                                  AutomationException

Schematic rule associated to the schematic builder rule.

Product Availability

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

Parameters:

schematicRule - A reference to a com.esri.arcgis.schematic.ISchematicRule (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 the schematic builder rule belongs to.

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.