com.esri.arcgis.schematic
Interface ISchematicElement

All Superinterfaces:
IObject, IRow, IRowBuffer, Serializable
All Known Implementing Classes:
ISchematicElementProxy, SchematicLink, SchematicNode, SchematicNodeOnLink, SchematicSubLink

public interface ISchematicElement
extends IObject, Serializable

Provides access to members that control the schematic element.

Description

Schematic elements are implemented by a schematic element class. These schematic elements display in schematic diagrams that are generated/opened in ArcMap, previewed in ArcCatalog, or created/visualized via any application developed with the ArcGIS Schematics API.

The schematic elements contained in a schematic diagram are regrouped into feature layers. There is a feature layer for each schematic element class that is associated with the diagram class that implements the diagram.

Product Availability

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


Method Summary
 void alterPropertySet(IPropertySet propertySet)
          Changes the schematic element PropertySet with the specified PropertySet.
 ISchematicElementAssociation createAssociation(int dataSourceID, int cLSID, int oID, int sUBID, String gUID)
          Create a schematic association.
 String getName()
          Name of the schematic element.
 IPropertySet getPropertySet()
          PropertySet related to the schematic element.
 ISchematicDiagram getSchematicDiagram()
          Schematic diagram related to the schematic element.
 ISchematicElementClass getSchematicElementClass()
          Schematic element class related to the schematic element.
 ISchematicElement getSchematicRelation()
          Schematic element relation ship.
 int getUpdateStatus()
          Update status of the element.
 boolean isDisplayed()
          Indicates if the element is displayed.
 boolean isInitial()
          Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.
 void setDisplayed(boolean displayed)
          Indicates if the element is displayed.
 void setInitial(boolean initial)
          Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.
 void setSchematicRelationByRef(ISchematicElement schematicElement)
          Schematic element relation ship.
 void setUpdateStatus(int updateStatus)
          Update status of the element.
 
Methods inherited from interface com.esri.arcgis.geodatabase.IObject
esri_getClass
 
Methods inherited from interface com.esri.arcgis.geodatabase.IRow
delete, getOID, getTable, isHasOID, store
 
Methods inherited from interface com.esri.arcgis.geodatabase.IRowBuffer
getFields, getValue, setValue
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the schematic element.

Product Availability

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

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElementClass

ISchematicElementClass getSchematicElementClass()
                                                throws IOException,
                                                       AutomationException
Schematic element class related to the schematic element.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElementClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagram

ISchematicDiagram getSchematicDiagram()
                                      throws IOException,
                                             AutomationException
Schematic diagram related to the schematic element.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInitial

boolean isInitial()
                  throws IOException,
                         AutomationException
Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.

Product Availability

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

Returns:
The initial
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInitial

void setInitial(boolean initial)
                throws IOException,
                       AutomationException
Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.

Product Availability

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

Parameters:
initial - The initial (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDisplayed

boolean isDisplayed()
                    throws IOException,
                           AutomationException
Indicates if the element is displayed.

Product Availability

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

Returns:
The displayed
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayed

void setDisplayed(boolean displayed)
                  throws IOException,
                         AutomationException
Indicates if the element is displayed.

Product Availability

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

Parameters:
displayed - The displayed (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUpdateStatus

int getUpdateStatus()
                    throws IOException,
                           AutomationException
Update status of the element.

Product Availability

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

Returns:
A com.esri.arcgis.schematic.esriSchematicUpdateStatus constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUpdateStatus

void setUpdateStatus(int updateStatus)
                     throws IOException,
                            AutomationException
Update status of the element.

Product Availability

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

Parameters:
updateStatus - A com.esri.arcgis.schematic.esriSchematicUpdateStatus constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicRelation

ISchematicElement getSchematicRelation()
                                       throws IOException,
                                              AutomationException
Schematic element relation ship.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicRelationByRef

void setSchematicRelationByRef(ISchematicElement schematicElement)
                               throws IOException,
                                      AutomationException
Schematic element relation ship.

Product Availability

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

Parameters:
schematicElement - A reference to a com.esri.arcgis.schematic.ISchematicElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createAssociation

ISchematicElementAssociation createAssociation(int dataSourceID,
                                               int cLSID,
                                               int oID,
                                               int sUBID,
                                               String gUID)
                                               throws IOException,
                                                      AutomationException
Create a schematic association.

Product Availability

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

Parameters:
dataSourceID - The dataSourceID (in)
cLSID - The cLSID (in)
oID - The oID (in)
sUBID - The sUBID (in)
gUID - The gUID (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElementAssociation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
PropertySet related to the schematic element.

Product Availability

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

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.

alterPropertySet

void alterPropertySet(IPropertySet propertySet)
                      throws IOException,
                             AutomationException
Changes the schematic element PropertySet with the specified PropertySet.

Product Availability

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

Parameters:
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.