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.

Product Availability

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

See Also:
INgDiagram

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.
 String getLastUpdateBy()
          Name of the last user that updated the schematic diagram.
 Date getLastUpdateDate()
          Last updating date of the schematic diagram.
 String getName()
          Name of the schematic diagram.
 IPropertySet getPropertySet()
          Schematic diagram PropertySet.
 ISchematicDiagramClass getSchematicDiagramClass()
          Schematic diagram class related to the schematic diagram.
 ISchematicDiagramContainer getSchematicDiagramContainer()
          Schematic diagram container related to 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 setLastUpdateBy(String name)
          Name of the last user that updated the schematic diagram.
 void setLastUpdateDate(Date date)
          Last updating date of 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 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.
See Also:
INgDiagram.getName()

setName

void setName(String name)
             throws IOException,
                    AutomationException
Name of 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.

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.
See Also:
ISchematicDiagram.getLastUpdateDate()

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.
See Also:
ISchematicDiagram.getCreationDate()

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.
See Also:
ISchematicDiagram

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.

getLastUpdateBy

String getLastUpdateBy()
                       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.
See Also:
ISchematicDiagram.getCreator()

setLastUpdateBy

void setLastUpdateBy(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.
See Also:
ISchematicDiagram.alterBuilderPropertySet(com.esri.arcgis.system.IPropertySet)

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.
See Also:
ISchematicDiagram.getBuilderPropertySet()

getPropertySet

IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
Schematic diagram PropertySet.

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.
See Also:
ISchematicDiagram.alterPropertySet(com.esri.arcgis.system.IPropertySet)

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.
See Also:
ISchematicDiagram.getPropertySet()