com.esri.arcgis.schematic
Interface ISchematicDiagram

All Superinterfaces:

IObject, IRow, IRowBuffer, Serializable

All Known Implementing Classes:

ISchematicDiagramProxy, SchematicDiagram

public interface ISchematicDiagram
extends IObject, Serializable

Provides access to members that control the schematic diagram.

Description

A schematic diagram is a set of schematic features (nodes, links, nodes on links, and sublinks) that has been generated using the Generate New Diagram command in ArcMap, the Create Diagram GP tool, or the ArcGIS Schematics API. It is displayed in a schematic layer, which is a composite layer composed of feature layers based on the schematic feature classes associated with the schematic diagram template. The content, symbology, and the way the schematic diagram is generated and displayed is configured in its schematic diagram class. A schematic diagram is stored in a geodatabase in a schematic diagram container; that is, a schematic dataset or a schematic folder of the schematic dataset.

Product Availability

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

Method Summary

void	alterBuilderPropertySet(IPropertySet propertySet) Changes the builder PropertySet related to the schematic diagram with the new specified builder PropertySet.
void	alterPropertySet(IPropertySet propertySet) Changes the Schematic diagram PropertySet with the new specified diagram PropertySet.
IPropertySet	getBuilderPropertySet() Builder PropertySet related to the schematic diagram.
Date	getCreationDate() Creation date of the schematic diagram.
String	getCreator() Name of the schematic diagram creator.
Date	getLastModificationDate() Last modification date of the schematic diagram.
Date	getLastUpdateDate() Last updating date of the schematic diagram.
String	getModifiedBy() Name of the user that modified the schematic diagram.
String	getName() Name of the schematic diagram.
IPropertySet	getPropertySet() PropertySet of the schematic diagram.
ISchematicDiagramClass	getSchematicDiagramClass() Schematic diagram class related to the schematic diagram.
ISchematicDiagramContainer	getSchematicDiagramContainer() Schematic diagram container related to the schematic diagram.
String	getUpdatedBy() Name of the last user that updated the schematic diagram.
String	getVersion() Version of the database used to create the schematic diagram.
void	setCreationDate(Date date) Creation date of the schematic diagram.
void	setCreator(String name) Name of the schematic diagram creator.
void	setLastModificationDate(Date date) Last modification date of the schematic diagram.
void	setLastUpdateDate(Date date) Last updating date of the schematic diagram.
void	setModifiedBy(String name) Name of the user that modified the schematic diagram.
void	setName(String name) Name of the schematic diagram.
void	setSchematicDiagramContainerByRef(ISchematicDiagramContainer diagramContainer) Schematic diagram container related to the schematic diagram.
void	setUpdatedBy(String name) Name of the last user that updated the schematic diagram.
void	setVersion(String versionName) Version of the database used to create the schematic diagram.

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

getSchematicDiagramClass

ISchematicDiagramClass getSchematicDiagramClass()
                                                throws IOException,
                                                       AutomationException

Schematic diagram class related to the schematic diagram.

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.

getSchematicDiagramContainer

ISchematicDiagramContainer getSchematicDiagramContainer()
                                                        throws IOException,
                                                               AutomationException

Schematic diagram container related to the schematic diagram. That is, the schematic folder or the schematic dataset for the schematic diagram storage.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramContainerByRef

void setSchematicDiagramContainerByRef(ISchematicDiagramContainer diagramContainer)
                                       throws IOException,
                                              AutomationException

Schematic diagram container related to the schematic diagram. That is, the schematic folder or the schematic dataset for the schematic diagram storage.

Product Availability

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

Parameters:

diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

Name of the schematic diagram.

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.

setName

void setName(String name)
             throws IOException,
                    AutomationException

Name of the schematic diagram.

Remarks

Schematics enforces the uniqueness of the schematic diagram name regarding:

• The name of its schematic dataset
• The names of all the schematic diagrams in its schematic dataset
• The names of all the schematic folders at the same level in the schematic dataset

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCreationDate

Date getCreationDate()
                     throws IOException,
                            AutomationException

Creation date of the schematic diagram.

Product Availability

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

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCreationDate

void setCreationDate(Date date)
                     throws IOException,
                            AutomationException

Creation date of the schematic diagram.

Product Availability

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

Parameters:

date - The date (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastUpdateDate

Date getLastUpdateDate()
                       throws IOException,
                              AutomationException

Last updating date of the schematic diagram.

Product Availability

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

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastUpdateDate

void setLastUpdateDate(Date date)
                       throws IOException,
                              AutomationException

Last updating date of the schematic diagram.

Product Availability

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

Parameters:

date - The date (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersion

String getVersion()
                  throws IOException,
                         AutomationException

Version of the database used to create the schematic diagram.

Product Availability

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

Returns:

The versionName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVersion

void setVersion(String versionName)
                throws IOException,
                       AutomationException

Version of the database used to create the schematic diagram.

Product Availability

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

Parameters:

versionName - The versionName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCreator

String getCreator()
                  throws IOException,
                         AutomationException

Name of the schematic diagram creator.

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.

setCreator

void setCreator(String name)
                throws IOException,
                       AutomationException

Name of the schematic diagram creator.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpdatedBy

String getUpdatedBy()
                    throws IOException,
                           AutomationException

Name of the last user that updated the schematic diagram.

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.

setUpdatedBy

void setUpdatedBy(String name)
                  throws IOException,
                         AutomationException

Name of the last user that updated the schematic diagram.

Product Availability

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

Parameters:

name - The name (in)

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.

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.

alterBuilderPropertySet

void alterBuilderPropertySet(IPropertySet propertySet)
                             throws IOException,
                                    AutomationException

Changes the builder PropertySet related to the schematic diagram with the new specified builder 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.

getPropertySet

IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

PropertySet of the schematic diagram.

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 diagram PropertySet with the new specified diagram 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.

getLastModificationDate

Date getLastModificationDate()
                             throws IOException,
                                    AutomationException

Last modification date of the schematic diagram.

Product Availability

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

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastModificationDate

void setLastModificationDate(Date date)
                             throws IOException,
                                    AutomationException

Last modification date of the schematic diagram.

Product Availability

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

Parameters:

date - The date (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModifiedBy

String getModifiedBy()
                     throws IOException,
                            AutomationException

Name of the user that modified the schematic diagram.

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.

setModifiedBy

void setModifiedBy(String name)
                   throws IOException,
                          AutomationException

Name of the user that modified the schematic diagram.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.