com.esri.arcgis.schematic
Class SchematicBuilderRule

java.lang.Object
  com.esri.arcgis.schematic.SchematicBuilderRule

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicBuilderRule, Serializable

public class SchematicBuilderRule
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicBuilderRule

Schematic builder rule object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicBuilderRule(Object obj)
Construct a SchematicBuilderRule using a reference to such an object returned from ArcGIS Engine or Server.

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.
boolean	equals(Object o) Compare this object with another
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.
int	hashCode() the hashcode for this object
boolean	isActive() Indicates if the schematic builder rule is active.
void	setIsActive(boolean active) Indicates if the schematic builder rule is active.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SchematicBuilderRule

public SchematicBuilderRule(Object obj)
                     throws IOException

Construct a SchematicBuilderRule using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicBuilderRule.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
SchematicBuilderRule o = (SchematicBuilderRule)obj; // will not work

SchematicBuilderRule o = new SchematicBuilderRule(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems SchematicBuilderRule theSchematicBuilderRule = (SchematicBuilderRule) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

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.