com.esri.arcgis.catalog
Interface IGxWMSConnection

All Superinterfaces:
Serializable
All Known Implementing Classes:
GxWMSConnection

public interface IGxWMSConnection
extends Serializable

Provides access to members to connect to an WMS server.

Product Availability

Available with ArcGIS Desktop.


Method Summary
 void connect()
          Connects to the WMS service.
 void disconnect()
          Disconnects from the WMS service.
 IWMSConnectionName getWMSConnectionName()
          Assosicated name object used to connect to a WMS service.
 boolean isConnected()
          Indicates whether the server is connected to or not.
 void loadFromFile(String path)
          Loads a WMS connection file.
 void saveToFile(String path)
          Writes a WMS connection file.
 void setWMSConnectionNameByRef(IWMSConnectionName connectionName)
          Assosicated name object used to connect to a WMS service.
 

Method Detail

getWMSConnectionName

IWMSConnectionName getWMSConnectionName()
                                        throws IOException,
                                               AutomationException
Assosicated name object used to connect to a WMS service.

Product Availability

Available with ArcGIS Desktop.

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

setWMSConnectionNameByRef

void setWMSConnectionNameByRef(IWMSConnectionName connectionName)
                               throws IOException,
                                      AutomationException
Assosicated name object used to connect to a WMS service.

Product Availability

Available with ArcGIS Desktop.

Parameters:
connectionName - A reference to a com.esri.arcgis.gisclient.IWMSConnectionName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadFromFile

void loadFromFile(String path)
                  throws IOException,
                         AutomationException
Loads a WMS connection file.

Product Availability

Available with ArcGIS Desktop.

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 a WMS connection file.

Product Availability

Available with ArcGIS Desktop.

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

isConnected

boolean isConnected()
                    throws IOException,
                           AutomationException
Indicates whether the server is connected to or not.

Product Availability

Available with ArcGIS Desktop.

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 the WMS service.

Product Availability

Available with ArcGIS Desktop.

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

disconnect

void disconnect()
                throws IOException,
                       AutomationException
Disconnects from the WMS service.

Product Availability

Available with ArcGIS Desktop.

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