com.esri.arcgis.catalog
Interface IIMSConnection

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMSConnection

public interface IIMSConnection
extends Serializable

Provides access to members to connect to an ArcIMS server (IMS).

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	connect() Connects to an ArcIMS server.
void	disconnect() Disconnects from an ArcIMS server.
String	getFileName() Path to the IMS connection file.
Object	getFilterServices() Filters out only the specified services.
String	getURL() URL to ArcIMS server.
String	getUserName() User name.
boolean	isConnected() Indicates whether the IMS connection has been made.
boolean	isSavePassword() Indicates if the password should be saved.
void	loadFromFile(String path) Loads an IMS connection file containing the URL.
void	saveToFile(String path) Writes an IMS connection file containing the URL.
void	setFilterServices(Object names) Filters out only the specified services.
void	setPassword(String rhs1) Password.
void	setSavePassword(boolean flag) Indicates if the password should be saved.
void	setURL(String uRL) URL to ArcIMS server.
void	setUserName(String userName) User name.

Method Detail

isConnected

boolean isConnected()
                    throws IOException,
                           AutomationException

Indicates whether the IMS 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 ArcIMS 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 ArcIMS 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 IMS connection file containing the URL.

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 IMS connection file containing the URL.

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 IMS 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.

getURL

String getURL()
              throws IOException,
                     AutomationException

URL to ArcIMS server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The uRL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setURL

void setURL(String uRL)
            throws IOException,
                   AutomationException

URL to ArcIMS server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

uRL - The uRL (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserName

void setUserName(String userName)
                 throws IOException,
                        AutomationException

User name.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

userName - The userName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserName

String getUserName()
                   throws IOException,
                          AutomationException

User name.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The userName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPassword

void setPassword(String rhs1)
                 throws IOException,
                        AutomationException

Password.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSavePassword

boolean isSavePassword()
                       throws IOException,
                              AutomationException

Indicates if the password should be saved.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSavePassword

void setSavePassword(boolean flag)
                     throws IOException,
                            AutomationException

Indicates if the password should be saved.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilterServices

Object getFilterServices()
                         throws IOException,
                                AutomationException

Filters out only the specified services. Array of strings.

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.

setFilterServices

void setFilterServices(Object names)
                       throws IOException,
                              AutomationException

Filters out only the specified services. Array of strings.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

names - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.