com.esri.arcgis.schematic
Interface ISchematicDiagramClass

All Superinterfaces:
IClass, IObjectClass, Serializable
All Known Implementing Classes:
ISchematicDiagramClassProxy, SchematicDiagramClass

public interface ISchematicDiagramClass
extends IObjectClass, Serializable

Provides access to members that control the schematic diagram class.

Product Availability

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

See Also:
ISchematicDiagram, INgDiagramType

Method Summary
 void alterAlgorithm(IUID uID, IPropertySet propertySet)
          Changes the algorithm defined for the schematic diagram class with the new specified algorithm CLSID and the new specified algorithm PropertySet.
 void alterBuilder(IUID uID, IPropertySet propertySet)
          Changes the builder defined for the schematic diagram class with the new specified builder CLSID and the new specified builder PropertySet.
 void alterLinker(IUID uID, IPropertySet propertySet)
          Changes the linker defined for the schematic diagram class with the new specified linker CLSID and the new specified linker PropertySet.
 void alterQuery(int dataSourceID, IPropertySet propertySet)
          Changes the query related to the schematic diagram class with the new specified datasource ID and the new specified query PropertySet.
 void associateElementClass(ISchematicElementClass schematicElementClass)
          Associates the specified schematic element class with the diagram class.
 ISchematicDiagram createSchematicDiagram(String name, ISchematicDiagramContainer diagramContainer)
          Creates a new schematic diagram.
 void dissociateElementClass(ISchematicElementClass schematicElementClass)
          Dissociate the specified schematic element class from the diagram class.
 IUID getAlgorithmCLSID()
          Algorithm CLSID defined for the schematic diagram class.
 IPropertySet getAlgorithmPropertySet()
          Algorithm PropertySet related to the schematic diagram class.
 IEnumSchematicElementClass getAssociatedElementClasses()
          List of the schematic element classes associated with the schematic diagram class.
 IUID getBuilderCLSID()
          Builder CLSID defined for the schematic diagram class.
 IPropertySet getBuilderPropertySet()
          Builder PropertySet related to the schematic diagram class.
 int getDataSourceID()
          ID of the datasource related to the schematic diagram class.
 IUID getLinkerCLSID()
          Linker CLSID defined for the schematic diagram class.
 IPropertySet getLinkerPropertySet()
          Linker PropertySet related to the schematic diagram class.
 ISchematicDiagramClass getParent()
          Parent diagram class of the schematic diagram class.
 IPropertySet getQueryPropertySet()
          Query PropertySet related to the schematic diagram class.
 ISchematicBuilder getSchematicBuilder()
          Schematic builder defined for the schematic diagram class.
 ISchematicDataset getSchematicDataset()
          Schematic dataset related to the schematic diagram class.
 ISchematicDiagram getSchematicDiagramByID(int iD, ISchematicDiagramContainer diagramContainer)
          Schematic diagram referenced by the specified ID from the specified schematic diagrams container.
 ISchematicDiagram getSchematicDiagramByName(String name, ISchematicDiagramContainer diagramContainer)
          Schematic diagram referenced by the schematic diagram class with the specified Name from the specified schematic diagrams container.
 IEnumSchematicDiagram getSchematicDiagrams(ISchematicDiagramContainer diagramContainer)
          List of the schematic diagrams related to the schematic diagram class within a specified schematic diagrams container.
 void setParentByRef(ISchematicDiagramClass parent)
          Parent diagram class of the schematic diagram class.
 
Methods inherited from interface com.esri.arcgis.geodatabase.IObjectClass
getAliasName, getObjectClassID, getRelationshipClasses
 
Methods inherited from interface com.esri.arcgis.geodatabase.IClass
addField, addIndex, deleteField, deleteIndex, findField, getCLSID, getEXTCLSID, getExtension, getExtensionProperties, getFields, getIndexes, getOIDFieldName, isHasOID
 

Method Detail

getParent

ISchematicDiagramClass getParent()
                                 throws IOException,
                                        AutomationException
Parent diagram class of the schematic diagram class.

Product Availability

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

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.

setParentByRef

void setParentByRef(ISchematicDiagramClass parent)
                    throws IOException,
                           AutomationException
Parent diagram class of the schematic diagram class.

Product Availability

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

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

createSchematicDiagram

ISchematicDiagram createSchematicDiagram(String name,
                                         ISchematicDiagramContainer diagramContainer)
                                         throws IOException,
                                                AutomationException
Creates a new schematic diagram.

Product Availability

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

Parameters:
name - The name (in)
diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in, optional, pass 0 if not required)
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.

getSchematicDiagrams

IEnumSchematicDiagram getSchematicDiagrams(ISchematicDiagramContainer diagramContainer)
                                           throws IOException,
                                                  AutomationException
List of the schematic diagrams related to the schematic diagram class within a specified schematic diagrams container.

Product Availability

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

Parameters:
diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in, optional, pass 0 if not required)
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicDiagram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramByID

ISchematicDiagram getSchematicDiagramByID(int iD,
                                          ISchematicDiagramContainer diagramContainer)
                                          throws IOException,
                                                 AutomationException
Schematic diagram referenced by the specified ID from the specified schematic diagrams container.

Product Availability

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

Parameters:
iD - The iD (in)
diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in, optional, pass 0 if not required)
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.

getSchematicDiagramByName

ISchematicDiagram getSchematicDiagramByName(String name,
                                            ISchematicDiagramContainer diagramContainer)
                                            throws IOException,
                                                   AutomationException
Schematic diagram referenced by the schematic diagram class with the specified Name from the specified schematic diagrams container.

Product Availability

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

Parameters:
name - The name (in)
diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in, optional, pass 0 if not required)
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.

getSchematicDataset

ISchematicDataset getSchematicDataset()
                                      throws IOException,
                                             AutomationException
Schematic dataset related to the schematic diagram class.

Product Availability

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

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

getDataSourceID

int getDataSourceID()
                    throws IOException,
                           AutomationException
ID of the datasource related to the schematic diagram class.

Product Availability

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

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

getQueryPropertySet

IPropertySet getQueryPropertySet()
                                 throws IOException,
                                        AutomationException
Query PropertySet related to the schematic diagram class.

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.

alterQuery

void alterQuery(int dataSourceID,
                IPropertySet propertySet)
                throws IOException,
                       AutomationException
Changes the query related to the schematic diagram class with the new specified datasource ID and the new specified query PropertySet.

Product Availability

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

Parameters:
dataSourceID - The dataSourceID (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.

getBuilderCLSID

IUID getBuilderCLSID()
                     throws IOException,
                            AutomationException
Builder CLSID defined for the schematic diagram class.

Product Availability

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

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.

getBuilderPropertySet

IPropertySet getBuilderPropertySet()
                                   throws IOException,
                                          AutomationException
Builder PropertySet related to the schematic diagram class.

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.

alterBuilder

void alterBuilder(IUID uID,
                  IPropertySet propertySet)
                  throws IOException,
                         AutomationException
Changes the builder defined for the schematic diagram class with the new specified builder CLSID and the new specified builder PropertySet.

Product Availability

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

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

getSchematicBuilder

ISchematicBuilder getSchematicBuilder()
                                      throws IOException,
                                             AutomationException
Schematic builder defined for the schematic diagram class.

Product Availability

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

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

getLinkerCLSID

IUID getLinkerCLSID()
                    throws IOException,
                           AutomationException
Linker CLSID defined for the schematic diagram class.

Product Availability

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

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.

getLinkerPropertySet

IPropertySet getLinkerPropertySet()
                                  throws IOException,
                                         AutomationException
Linker PropertySet related to the schematic diagram class.

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.

alterLinker

void alterLinker(IUID uID,
                 IPropertySet propertySet)
                 throws IOException,
                        AutomationException
Changes the linker defined for the schematic diagram class with the new specified linker CLSID and the new specified linker PropertySet.

Product Availability

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

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

getAlgorithmCLSID

IUID getAlgorithmCLSID()
                       throws IOException,
                              AutomationException
Algorithm CLSID defined for the schematic diagram class.

Product Availability

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

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.

getAlgorithmPropertySet

IPropertySet getAlgorithmPropertySet()
                                     throws IOException,
                                            AutomationException
Algorithm PropertySet related to the schematic diagram class.

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.

alterAlgorithm

void alterAlgorithm(IUID uID,
                    IPropertySet propertySet)
                    throws IOException,
                           AutomationException
Changes the algorithm defined for the schematic diagram class with the new specified algorithm CLSID and the new specified algorithm PropertySet.

Product Availability

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

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

associateElementClass

void associateElementClass(ISchematicElementClass schematicElementClass)
                           throws IOException,
                                  AutomationException
Associates the specified schematic element class with the diagram class.

Product Availability

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

Parameters:
schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicDiagramClass.dissociateElementClass(com.esri.arcgis.schematic.ISchematicElementClass), ISchematicDiagramClass.getAssociatedElementClasses()

dissociateElementClass

void dissociateElementClass(ISchematicElementClass schematicElementClass)
                            throws IOException,
                                   AutomationException
Dissociate the specified schematic element class from the diagram class.

Product Availability

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

Parameters:
schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicDiagramClass.getAssociatedElementClasses()

getAssociatedElementClasses

IEnumSchematicElementClass getAssociatedElementClasses()
                                                       throws IOException,
                                                              AutomationException
List of the schematic element classes associated with the schematic diagram class.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicElementClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicDiagramClass.associateElementClass(com.esri.arcgis.schematic.ISchematicElementClass), ISchematicDiagramClass.dissociateElementClass(com.esri.arcgis.schematic.ISchematicElementClass)