com.esri.arcgis.schematic
Interface ISchematicDiagramClass

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

public interface ISchematicDiagramClass
extends IObjectClass, java.io.Serializable

Provides access to members that control the schematic diagram class.


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(java.lang.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(java.lang.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

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

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

setParentByRef

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

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

createSchematicDiagram

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagrams

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramByID

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramByName

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDataset

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

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

getDataSourceID

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

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

getQueryPropertySet

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

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

alterQuery

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

Parameters:
dataSourceID - The dataSourceID (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBuilderCLSID

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

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

getBuilderPropertySet

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

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

alterBuilder

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

Parameters:
uID - A reference to a com.esri.arcgis.system.IUID (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicBuilder

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

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

getLinkerCLSID

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

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

getLinkerPropertySet

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

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

alterLinker

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

Parameters:
uID - A reference to a com.esri.arcgis.system.IUID (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

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

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

getAlgorithmPropertySet

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

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

alterAlgorithm

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

Parameters:
uID - A reference to a com.esri.arcgis.system.IUID (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

associateElementClass

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

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

dissociateElementClass

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

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

getAssociatedElementClasses

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

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