com.esri.arcgis.catalog
Interface IGxAGSConnection

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GxAGSConnection, IGxAGSConnectionProxy

public interface IGxAGSConnection
extends java.io.Serializable

COM Interface 'IGxAGSConnection'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description: 'Provides access to members of GxObject that connects to an ArcGIS server (AGS).' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID85e89175_26ef_490b_8fcc_9363399275bb
static int	xxDummy Deprecated. Internal use only

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.
java.lang.String	getFileName() Path to the AGS connection file.
java.lang.Object	getSelectedServerObjects() The selected server objects.
boolean	isConnected() Indicates whether the AGS connection has been made.
void	loadFromFile(java.lang.String path) Loads an AGS connection file.
void	saveToFile(java.lang.String path) Writes an AGS connection file.
void	setAGSServerConnectionNameByRef(IAGSServerConnectionName serverConnName) The associated AGS server connection name object.
void	setSelectedServerObjects(java.lang.Object selectedObjects) The selected server objects.

Field Detail

IID85e89175_26ef_490b_8fcc_9363399275bb

static final int IID85e89175_26ef_490b_8fcc_9363399275bb

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

isConnected

boolean isConnected()
                    throws java.io.IOException,
                           AutomationException

Indicates whether the AGS connection has been made.

Returns:

The isConnected

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

void connect()
             throws java.io.IOException,
                    AutomationException

Connects to an ArcGIS server.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

void disconnect()
                throws java.io.IOException,
                       AutomationException

Disconnects from an ArcGIS server.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromFile

void loadFromFile(java.lang.String path)
                  throws java.io.IOException,
                         AutomationException

Loads an AGS connection file.

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveToFile

void saveToFile(java.lang.String path)
                throws java.io.IOException,
                       AutomationException

Writes an AGS connection file.

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileName

java.lang.String getFileName()
                             throws java.io.IOException,
                                    AutomationException

Path to the AGS connection file.

Returns:

The fileName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAGSServerConnectionName

IAGSServerConnectionName getAGSServerConnectionName()
                                                    throws java.io.IOException,
                                                           AutomationException

The associated AGS server connection name object.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAGSServerConnectionNameByRef

void setAGSServerConnectionNameByRef(IAGSServerConnectionName serverConnName)
                                     throws java.io.IOException,
                                            AutomationException

The associated AGS server connection name object.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedServerObjects

java.lang.Object getSelectedServerObjects()
                                          throws java.io.IOException,
                                                 AutomationException

The selected server objects.

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedServerObjects

void setSelectedServerObjects(java.lang.Object selectedObjects)
                              throws java.io.IOException,
                                     AutomationException

The selected server objects.

Parameters:

selectedObjects - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editServerProperties

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

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

Parameters:

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

activePage - The activePage (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.