com.esri.arcgis.schematic
Interface ISchematicDataset

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicDatasetProxy, SchematicDataset

public interface ISchematicDataset
extends Serializable

Provides access to members that manage the schematic dataset.

Product Availability

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

Method Summary

ISchematicDataSource	createSchematicDataSource(String name, ISchematicConnection schematicConnection) Creates a new schematic data source inside the schematic dataset.
ISchematicDiagramClass	createSchematicDiagramClass(String name) Creates a new schematic diagram class inside the schematic dataset.
ISchematicElementClass	createSchematicElementClass(String name, int type) Creates a new schematic element class inside the schematic dataset.
ISchematicFolder	createSchematicFolder(String name) Creates a new schematic folder in the schematic dataset.
ISchematicDataSource	getDefaultSchematicDataSource() Cuurent schematic data source.
int	getID() ID of the schematic dataset.
IEnumSchematicInMemoryDiagram	getSchematicInMemoryDiagrams() Opened schematic in memory diagrams of the schematic dataset.
ISchematicWorkspace	getSchematicWorkspace() Schematic workspace related to the schematic dataset.
boolean	isDesignMode() Indicates if the schematic dataset design mode is activated.
boolean	isHasChanged() Indicates if the schematic dataset has changed.
void	save(int saveVersion, boolean canDeleteNonEmptyTables) Saves the schematic dataset.
void	setDesignMode(boolean designMode) Indicates if the schematic dataset design mode is activated.
void	setHasChanged(boolean hasChanged) Indicates if the schematic dataset has changed.

Method Detail

getID

int getID()
          throws IOException,
                 AutomationException

ID of the schematic dataset.

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.

getSchematicWorkspace

ISchematicWorkspace getSchematicWorkspace()
                                          throws IOException,
                                                 AutomationException

Schematic workspace related to the schematic dataset.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasChanged

boolean isHasChanged()
                     throws IOException,
                            AutomationException

Indicates if the schematic dataset has changed.

Product Availability

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

Returns:

The hasChanged

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasChanged

void setHasChanged(boolean hasChanged)
                   throws IOException,
                          AutomationException

Indicates if the schematic dataset has changed.

Product Availability

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

Parameters:

hasChanged - The hasChanged (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

void save(int saveVersion,
          boolean canDeleteNonEmptyTables)
          throws IOException,
                 AutomationException

Saves the schematic dataset.

Product Availability

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

Parameters:

saveVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

canDeleteNonEmptyTables - The canDeleteNonEmptyTables (in, optional, pass false if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryDiagrams

IEnumSchematicInMemoryDiagram getSchematicInMemoryDiagrams()
                                                           throws IOException,
                                                                  AutomationException

Opened schematic in memory diagrams of the schematic dataset.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSchematicDiagramClass

ISchematicDiagramClass createSchematicDiagramClass(String name)
                                                   throws IOException,
                                                          AutomationException

Creates a new schematic diagram class inside the schematic dataset.

Product Availability

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

Parameters:

name - The name (in)

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.

createSchematicElementClass

ISchematicElementClass createSchematicElementClass(String name,
                                                   int type)
                                                   throws IOException,
                                                          AutomationException

Creates a new schematic element class inside the schematic dataset.

Product Availability

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

Parameters:

name - The name (in)

type - A com.esri.arcgis.schematic.esriSchematicElementType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSchematicDataSource

ISchematicDataSource createSchematicDataSource(String name,
                                               ISchematicConnection schematicConnection)
                                               throws IOException,
                                                      AutomationException

Creates a new schematic data source inside the schematic dataset.

Product Availability

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

Parameters:

name - The name (in)

schematicConnection - A reference to a com.esri.arcgis.schematic.ISchematicConnection (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSchematicFolder

ISchematicFolder createSchematicFolder(String name)
                                       throws IOException,
                                              AutomationException

Creates a new schematic folder in the schematic dataset.

Product Availability

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

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultSchematicDataSource

ISchematicDataSource getDefaultSchematicDataSource()
                                                   throws IOException,
                                                          AutomationException

Cuurent schematic data source.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDesignMode

boolean isDesignMode()
                     throws IOException,
                            AutomationException

Indicates if the schematic dataset design mode is activated.

Product Availability

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

Returns:

The designMode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDesignMode

void setDesignMode(boolean designMode)
                   throws IOException,
                          AutomationException

Indicates if the schematic dataset design mode is activated.

Product Availability

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

Parameters:

designMode - The designMode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.