com.esri.arcgis.schematic
Interface ISchematicDataSource

All Superinterfaces:
Serializable
All Known Implementing Classes:
ISchematicDataSourceProxy, SchematicDataSource

public interface ISchematicDataSource
extends Serializable

Provides access to members that controls the schematic datasource.

Product Availability

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

See Also:
INgDataSource

Method Summary
 void alter(IUID cLSID, IMemoryBlobStream connectionBlob)
          Changes the schematic datasource with the new specified CLSID and the new specified connection definition.
 void delete()
          Deletes the schematic datasource.
 IUID getCLSID()
          CLSID of the schematic datasource.
 IMemoryBlobStream getConnectionBlob()
          Blob stream that allows to connect to schematic datasource.
 int getID()
          ID of the schematic datasource.
 String getLabel()
          Label of the schematic datasource.
 String getName()
          Name of the schematic datasource.
 ISchematicDataset getSchematicDataset()
          Schematic dataset related to the schematic datasource.
 void setLabel(String label)
          Label of the schematic datasource.
 void setName(String name)
          Name of the schematic datasource.
 

Method Detail

getSchematicDataset

ISchematicDataset getSchematicDataset()
                                      throws IOException,
                                             AutomationException
Schematic dataset related to the schematic datasource.

Product Availability

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

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

getID

int getID()
          throws IOException,
                 AutomationException
ID of the schematic datasource.

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.
See Also:
ISchematicDataSource.getCLSID(), ISchematicDataSource.getLabel(), ISchematicDataSource.getName()

getName

String getName()
               throws IOException,
                      AutomationException
Name of the schematic datasource.

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:
ISchematicDataSource.getCLSID(), ISchematicDataSource.getLabel(), ISchematicDataSource.getID()

setName

void setName(String name)
             throws IOException,
                    AutomationException
Name of the schematic datasource.

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.

getLabel

String getLabel()
                throws IOException,
                       AutomationException
Label of the schematic datasource.

Product Availability

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

Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicDataSource.getCLSID(), ISchematicDataSource.getID(), ISchematicDataSource.getName()

setLabel

void setLabel(String label)
              throws IOException,
                     AutomationException
Label of the schematic datasource.

Product Availability

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

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

getCLSID

IUID getCLSID()
              throws IOException,
                     AutomationException
CLSID of the schematic datasource.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicDataSource.getLabel(), ISchematicDataSource.getID(), ISchematicDataSource.getName()

getConnectionBlob

IMemoryBlobStream getConnectionBlob()
                                    throws IOException,
                                           AutomationException
Blob stream that allows to connect to schematic datasource.

Product Availability

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

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

alter

void alter(IUID cLSID,
           IMemoryBlobStream connectionBlob)
           throws IOException,
                  AutomationException
Changes the schematic datasource with the new specified CLSID and the new specified connection definition.

Product Availability

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

Parameters:
cLSID - A reference to a com.esri.arcgis.system.IUID (in)
connectionBlob - A reference to a com.esri.arcgis.system.IMemoryBlobStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

void delete()
            throws IOException,
                   AutomationException
Deletes the schematic datasource.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.