com.esri.arcgis.schematic
Interface ISchematicConnection

All Superinterfaces:
Serializable
All Known Implementing Classes:
SchematicADOConnection, SchematicADOExtendedConnection, SchematicDAOConnection, SchematicDAOOdbcDirectConnection, SchematicGDBAccessConnection, SchematicGDBFileConnection, SchematicGDBOleDBConnection, SchematicGDBSdeConnection

public interface ISchematicConnection
extends Serializable

Provides access to members that manage the schematic connection.

Product Availability

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


Method Summary
 String getCLSID()
          The CLSID of the schematic connection.
 String getDescription()
          The description of the schematic connection.
 String getInitString()
          String used to initialize the schematic connection.
 Object getObject()
          Encapsulated object of the schematic connection.
 int getState()
          The schematic connection state of the schematic connection.
 void open()
          Opens the schematic connection.
 void setInitString(String initString)
          String used to initialize the schematic connection.
 void setObjectByRef(Object object)
          Encapsulated object of the schematic connection.
 

Method Detail

getObject

Object getObject()
                 throws IOException,
                        AutomationException
Encapsulated object of the schematic connection.

Product Availability

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

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectByRef

void setObjectByRef(Object object)
                    throws IOException,
                           AutomationException
Encapsulated object of the schematic connection.

Product Availability

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

Parameters:
object - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInitString

String getInitString()
                     throws IOException,
                            AutomationException
String used to initialize the schematic connection.

Product Availability

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

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

setInitString

void setInitString(String initString)
                   throws IOException,
                          AutomationException
String used to initialize the schematic connection.

Product Availability

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

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

open

void open()
          throws IOException,
                 AutomationException
Opens the schematic connection.

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.

getCLSID

String getCLSID()
                throws IOException,
                       AutomationException
The CLSID of the schematic connection.

Product Availability

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

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

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
The description of the schematic connection.

Product Availability

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

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

getState

int getState()
             throws IOException,
                    AutomationException
The schematic connection state of the schematic connection.

Product Availability

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

Returns:
A com.esri.arcgis.schematic.esriSchematicConnectionState constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.