com.esri.arcgis.schematic
Class SchematicBuilderRule

java.lang.Object
  extended by 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 delete()
          Deletes the schematic builder rule.
 boolean equals(Object o)
          Compare this object with another
 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.
 int hashCode()
          the hashcode for this object
 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.
 
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

isActive

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

Specified by:
isActive in interface ISchematicBuilderRule
Returns:
The active
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsActive

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

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.

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.

getSchematicRule

public ISchematicRule getSchematicRule()
                                throws IOException,
                                       AutomationException
Schematic rule associated to the schematic builder rule.

Product Availability

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

Specified by:
getSchematicRule in interface ISchematicBuilderRule
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

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

Specified by:
setSchematicRuleByRef in interface ISchematicBuilderRule
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

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

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.