com.esri.arcgis.schematic
Interface ISchematicDiagramClass

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

public interface ISchematicDiagramClass
extends ISchematicObjectClass, java.io.Serializable

COM Interface 'ISchematicDiagramClass'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description: 'Provides access to members that manage the schematic diagram class.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID3e87b44d_7047_4295_8e86_eaa59a5cbfba
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicObjectClass
IID55d6b6d9_5539_486f_95f8_084ef4e6fc13
 
Method Summary
 void associateSchematicElementClass(ISchematicElementClass schematicElementClass)
          Associates the element class to the schematic diagram class.
 ISchematicDiagram createSchematicDiagram(java.lang.String name, ISchematicDiagramContainer diagramContainer)
          Creates a new schematic diagram.
 void dissociateSchematicElementClass(ISchematicElementClass schematicElementClass)
          Dissociates the element class from the schematic diagram class.
 IEnumSchematicElementClass getAssociatedSchematicElementClasses()
          The associated element classes to the schematic diagram class.
 ISchematicElementClass getDefaultSchematicNodeClass()
          Default schematic in memory node element class related to the schematic diagram class.
 ISchematicDiagramClass getParent()
          Parent of the schematic diagram class.
 ISchematicAlgorithm getSchematicAlgorithm()
          Schematic algorithm of the schematic diagram class.
 IEnumSchematicAlgorithm getSchematicAlgorithms()
          Schematic algorithms of the schematic diagram class.
 ISchematicBuilder getSchematicBuilder()
          Schematic builder of the schematic diagram class.
 ISchematicDiagram getSchematicDiagramByID(int iD)
          Schematic diagram referenced by the specified ID.
 ISchematicDiagram getSchematicDiagramByName(java.lang.String name)
          Schematic diagram referenced by the specified Name.
 IEnumSchematicDiagram getSchematicDiagrams()
          Schematic diagrams enumeration within the schematic dataset or schematic folder container.
 ISchematicLayer getSchematicLayerTemplate()
          Schematic layer template related to the schematic diagram class.
 IEnumSchematicAlgorithm getSchematicTraces()
          Schematic analyst traces of the schematic diagram class.
 boolean isAlwaysLoadDiagrams()
          Indicates if the diagrams which belong to the diagram class are always loaded.
 boolean isSchematicElementClassAssociated(ISchematicElementClass schematicElementClass)
          Indicates whether or not the element class is associated to the schematic diagram class.
 ISchematicInMemoryDiagram loadSchematicInMemoryDiagram(java.lang.String diagramName)
          Loads a schematic in memory diagram specified by its DiagramName.
 void setAlwaysLoadDiagrams(boolean alwaysLoadDiagrams)
          Indicates if the diagrams which belong to the diagram class are always loaded.
 void setDefaultSchematicNodeClass(ISchematicElementClass schematicElementClass)
          Default schematic in memory node element class related to the schematic diagram class.
 void setParentByRef(ISchematicDiagramClass parent)
          Parent of the schematic diagram class.
 void setSchematicAlgorithmByRef(ISchematicAlgorithm schematicAlgorithm)
          Schematic algorithm of the schematic diagram class.
 void setSchematicAlgorithmsByRef(IEnumSchematicAlgorithm schematicAlgorithms)
          Schematic algorithms of the schematic diagram class.
 void setSchematicBuilderByRef(ISchematicBuilder schematicBuilder)
          Schematic builder of the schematic diagram class.
 void setSchematicLayerTemplate(ISchematicLayer schematicLayer)
          Schematic layer template related to the schematic diagram class.
 void setSchematicTracesByRef(IEnumSchematicAlgorithm schematicAlgorithms)
          Schematic analyst traces of the schematic diagram class.
 
Methods inherited from interface com.esri.arcgis.schematic.ISchematicObjectClass
createSchematicAttribute, delete, getExternalQueryEvaluationMode, getIdentifierFieldNames, getName, getPredefinedAttributeNames, getQueryString, getSchematicDataset, getSchematicDataSource, getSchematicQueryParameters, setExternalQueryEvaluationMode, setIdentifierFieldNames, setName, setQueryString, setSchematicDataSourceByRef, setSchematicQueryParameters
 

Field Detail

IID3e87b44d_7047_4295_8e86_eaa59a5cbfba

static final int IID3e87b44d_7047_4295_8e86_eaa59a5cbfba
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getParent

ISchematicDiagramClass getParent()
                                 throws java.io.IOException,
                                        AutomationException
Parent 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

void setParentByRef(ISchematicDiagramClass parent)
                    throws java.io.IOException,
                           AutomationException
Parent 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.

getAssociatedSchematicElementClasses

IEnumSchematicElementClass getAssociatedSchematicElementClasses()
                                                                throws java.io.IOException,
                                                                       AutomationException
The associated element classes to 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.

associateSchematicElementClass

void associateSchematicElementClass(ISchematicElementClass schematicElementClass)
                                    throws java.io.IOException,
                                           AutomationException
Associates the element class to the schematic 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.

dissociateSchematicElementClass

void dissociateSchematicElementClass(ISchematicElementClass schematicElementClass)
                                     throws java.io.IOException,
                                            AutomationException
Dissociates the element class from the schematic 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.

isSchematicElementClassAssociated

boolean isSchematicElementClassAssociated(ISchematicElementClass schematicElementClass)
                                          throws java.io.IOException,
                                                 AutomationException
Indicates whether or not the element class is associated to the schematic diagram class.

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

getSchematicBuilder

ISchematicBuilder getSchematicBuilder()
                                      throws java.io.IOException,
                                             AutomationException
Schematic builder of 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.

setSchematicBuilderByRef

void setSchematicBuilderByRef(ISchematicBuilder schematicBuilder)
                              throws java.io.IOException,
                                     AutomationException
Schematic builder of the schematic diagram class.

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

getSchematicAlgorithm

ISchematicAlgorithm getSchematicAlgorithm()
                                          throws java.io.IOException,
                                                 AutomationException
Schematic algorithm of the schematic diagram class.

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

setSchematicAlgorithmByRef

void setSchematicAlgorithmByRef(ISchematicAlgorithm schematicAlgorithm)
                                throws java.io.IOException,
                                       AutomationException
Schematic algorithm of the schematic diagram class.

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

getSchematicAlgorithms

IEnumSchematicAlgorithm getSchematicAlgorithms()
                                               throws java.io.IOException,
                                                      AutomationException
Schematic algorithms of the schematic diagram class.

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

setSchematicAlgorithmsByRef

void setSchematicAlgorithmsByRef(IEnumSchematicAlgorithm schematicAlgorithms)
                                 throws java.io.IOException,
                                        AutomationException
Schematic algorithms of the schematic diagram class.

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

getSchematicTraces

IEnumSchematicAlgorithm getSchematicTraces()
                                           throws java.io.IOException,
                                                  AutomationException
Schematic analyst traces of the schematic diagram class.

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

setSchematicTracesByRef

void setSchematicTracesByRef(IEnumSchematicAlgorithm schematicAlgorithms)
                             throws java.io.IOException,
                                    AutomationException
Schematic analyst traces of the schematic diagram class.

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

loadSchematicInMemoryDiagram

ISchematicInMemoryDiagram loadSchematicInMemoryDiagram(java.lang.String diagramName)
                                                       throws java.io.IOException,
                                                              AutomationException
Loads a schematic in memory diagram specified by its DiagramName.

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

isAlwaysLoadDiagrams

boolean isAlwaysLoadDiagrams()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the diagrams which belong to the diagram class are always loaded.

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

setAlwaysLoadDiagrams

void setAlwaysLoadDiagrams(boolean alwaysLoadDiagrams)
                           throws java.io.IOException,
                                  AutomationException
Indicates if the diagrams which belong to the diagram class are always loaded.

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

setSchematicLayerTemplate

void setSchematicLayerTemplate(ISchematicLayer schematicLayer)
                               throws java.io.IOException,
                                      AutomationException
Schematic layer template related to the schematic diagram class.

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

getSchematicLayerTemplate

ISchematicLayer getSchematicLayerTemplate()
                                          throws java.io.IOException,
                                                 AutomationException
Schematic layer template related to the schematic diagram class.

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

setDefaultSchematicNodeClass

void setDefaultSchematicNodeClass(ISchematicElementClass schematicElementClass)
                                  throws java.io.IOException,
                                         AutomationException
Default schematic in memory node element class related to the schematic 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.

getDefaultSchematicNodeClass

ISchematicElementClass getDefaultSchematicNodeClass()
                                                    throws java.io.IOException,
                                                           AutomationException
Default schematic in memory node element class related to the schematic diagram class.

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

createSchematicDiagram

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

IEnumSchematicDiagram getSchematicDiagrams()
                                           throws java.io.IOException,
                                                  AutomationException
Schematic diagrams enumeration within the schematic dataset or schematic folder container.

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

ISchematicDiagram getSchematicDiagramByID(int iD)
                                          throws java.io.IOException,
                                                 AutomationException
Schematic diagram referenced by the specified ID.

Parameters:
iD - The iD (in)
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

ISchematicDiagram getSchematicDiagramByName(java.lang.String name)
                                            throws java.io.IOException,
                                                   AutomationException
Schematic diagram referenced by the specified Name.

Parameters:
name - The name (in)
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.