com.esri.arcgis.schematic
Class ISchematicBuilderRuleProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.schematic.ISchematicBuilderRuleProxy

All Implemented Interfaces:

ISchematicBuilderRule, Externalizable, Serializable

public class ISchematicBuilderRuleProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicBuilderRule, 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, Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	ISchematicBuilderRuleProxy()
	ISchematicBuilderRuleProxy(Object obj)
protected	ISchematicBuilderRuleProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	setIsActive(boolean active) Indicates if the schematic builder rule is active.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ISchematicBuilderRuleProxy

public ISchematicBuilderRuleProxy()

ISchematicBuilderRuleProxy

public ISchematicBuilderRuleProxy(Object obj)
                           throws IOException

Throws:

IOException

ISchematicBuilderRuleProxy

protected ISchematicBuilderRuleProxy(Object obj,
                                     String iid)
                              throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getID

public int getID()
          throws IOException,
                 AutomationException

ID of the schematic builder rule.

Product Availability

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

Specified by:

getID in interface ISchematicBuilderRule

Returns:

The lRuleID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicBuilderRule.getCLSID()

setIsActive

public 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.

Specified by:

setIsActive in interface ISchematicBuilderRule

Parameters:

active - The active (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isActive

public boolean isActive()
                 throws IOException,
                        AutomationException

Indicates if the schematic builder rule is active.

Product Availability

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

Specified by:

isActive in interface ISchematicBuilderRule

Returns:

The active

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrderNumber

public int getOrderNumber()
                   throws IOException,
                          AutomationException

Order number of the schematic builder rule.

Product Availability

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

Specified by:

getOrderNumber in interface ISchematicBuilderRule

Returns:

The orderNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException

CLSID of the schematic builder rule.

Product Availability

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

Specified by:

getCLSID in interface ISchematicBuilderRule

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

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

PropertySet related to the schematic builder rule.

Product Availability

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

Specified by:

getPropertySet in interface ISchematicBuilderRule

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

public 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.

Specified by:

alter in interface ISchematicBuilderRule

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

public 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.

Specified by:

getSchematicDiagramClass in interface ISchematicBuilderRule

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

public void delete()
            throws IOException,
                   AutomationException

Deletes the schematic builder rule.

Product Availability

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

Specified by:

delete in interface ISchematicBuilderRule

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public 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.

Specified by:

apply in interface ISchematicBuilderRule

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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

ClassNotFoundException