com.esri.arcgis.catalog
Interface IGxAGSConnection

All Superinterfaces:

Serializable

All Known Implementing Classes:

GxAGSConnection

public interface IGxAGSConnection
extends Serializable

Provides access to members of GxObject that connects to an ArcGIS server (AGS).

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	connect() Connects to an ArcGIS server.
void	disconnect() Disconnects from an ArcGIS server.
void	editServerProperties(int hParent, short activePage) Presents a modal dialog to allow editing the default properties of the server.
IAGSServerConnectionName	getAGSServerConnectionName() The associated AGS server connection name object.
String	getFileName() Path to the AGS connection file.
Object	getSelectedServerObjects() The selected server objects.
boolean	isConnected() Indicates whether the AGS connection has been made.
void	loadFromFile(String path) Loads an AGS connection file.
void	saveToFile(String path) Writes an AGS connection file.
void	setAGSServerConnectionNameByRef(IAGSServerConnectionName serverConnName) The associated AGS server connection name object.
void	setSelectedServerObjects(Object selectedObjects) The selected server objects.

Method Detail

isConnected

boolean isConnected()
                    throws IOException,
                           AutomationException

Indicates whether the AGS connection has been made.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isConnected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

void connect()
             throws IOException,
                    AutomationException

Connects to an ArcGIS server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

void disconnect()
                throws IOException,
                       AutomationException

Disconnects from an ArcGIS server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromFile

void loadFromFile(String path)
                  throws IOException,
                         AutomationException

Loads an AGS connection file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveToFile

void saveToFile(String path)
                throws IOException,
                       AutomationException

Writes an AGS connection file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileName

String getFileName()
                   throws IOException,
                          AutomationException

Path to the AGS connection file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The fileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAGSServerConnectionName

IAGSServerConnectionName getAGSServerConnectionName()
                                                    throws IOException,
                                                           AutomationException

The associated AGS server connection name object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAGSServerConnectionNameByRef

void setAGSServerConnectionNameByRef(IAGSServerConnectionName serverConnName)
                                     throws IOException,
                                            AutomationException

The associated AGS server connection name object.

Product Availability

Available with ArcGIS Desktop.

Parameters:

serverConnName - A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedServerObjects

Object getSelectedServerObjects()
                                throws IOException,
                                       AutomationException

The selected server objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedServerObjects

void setSelectedServerObjects(Object selectedObjects)
                              throws IOException,
                                     AutomationException

The selected server objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

selectedObjects - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editServerProperties

void editServerProperties(int hParent,
                          short activePage)
                          throws IOException,
                                 AutomationException

Presents a modal dialog to allow editing the default properties of the server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

hParent - The hParent (A COM typedef) (in)

activePage - The activePage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.