com.esri.arcgis.schematic
Interface ISchematicRule

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISchematicRuleProxy, SchematicCollapseRelatedElementsRule, SchematicExpandLinksByAttributeRule, SchematicFeatureRemovalRule, SchematicNodeReductionRuleByFlow, SchematicNodeReductionRuleByPriority, SchematicRelationshipRule, SchematicRouteNodeReductionRule, SchematicSpatialQueryRule

public interface ISchematicRule
extends java.io.Serializable

COM Interface 'ISchematicRule'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description: 'Provides access to members that manage the schematic rule.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID0f611689_2c12_4e4d_80b9_cca2b3d5c7f4
static int	xxDummy Deprecated. Internal use only

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.
java.lang.String	getDescription() Description of the schematic rule.
java.lang.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.

Field Detail

IID0f611689_2c12_4e4d_80b9_cca2b3d5c7f4

static final int IID0f611689_2c12_4e4d_80b9_cca2b3d5c7f4

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the schematic rule.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Description of the schematic rule.

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

IUID getClassID()
                throws java.io.IOException,
                       AutomationException

ClassID of the schematic rule.

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertySet

IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException

PropertySet related to the schematic rule.

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClass

ISchematicDiagramClass getSchematicDiagramClass()
                                                throws java.io.IOException,
                                                       AutomationException

Schematic diagram class related to the schematic rule.

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alter

void alter(ISchematicDiagramClass schematicDiagramClass,
           IPropertySet propertySet)
           throws java.io.IOException,
                  AutomationException

Changes the schematic rule for the specified schematic diagram class with the specified rule type PropertySet.

Parameters:

schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

void apply(ISchematicInMemoryDiagram inMemoryDiagram,
           ITrackCancel cancelTracker)
           throws java.io.IOException,
                  AutomationException

Applies the schematic rule on the specified schematic in memory diagram.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.