Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.gisclient
Interface IWMSServiceDescription

All Superinterfaces:
Serializable
All Known Implementing Classes:
WMSConnection
public interface IWMSServiceDescription
extends Serializable

Provides access to members give access to WMSServiceDescription information.

Remarks

IWMSServiceDescription provides access to members that describe the capabilities of a WMS service.

Product Availability

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

Method Summary
 void fireWMSException(String requestType, String requestURL, IWMSServiceExceptionHandler pException)
          Notifies listeners about a valid exception from the WMS Service.
 void fireWMSRequest(String requestType, String requestURL)
          Notifies listeners about the URL request made to this WMS Service.
 String getBaseURL(String capability, String requestMethod)
          Base url for given capability and request method.
 String getExceptionFormat(int index)
          Supported exception at the given index.
 int getExceptionFormatCount()
          Supported exception format count.
 String getFeatureInfoFormat(int index)
          Supported FeatureInfoFormat at the given index.
 int getFeatureInfoFormatCount()
          Supported FeatureInfoFormat count.
 String getFeatureInfoRequestURL(IArray pLayers, IEnvelope pBoundingBox, int imageWidth, int imageHeight, int positionX, int positionY, int featureCount, String responseFormat)
          The url to download the feature info from.
 String getImageFormat(int index)
          Supported GetMap's ImageFormat at the given index.
 int getImageFormatCount()
          Supported GetMap's ImageFormat count.
 String getImageRequestUrl(IArray pLayers, IEnvelope pBoundingBox, int imageWidth, int imageHeight, int bgColor, String responseFormat, boolean drawTransparent)
          The URL to download the map image from.
 IWMSLayerDescription getLayerDescription(int index)
          WMS layer information at the given index.
 int getLayerDescriptionCount()
          WMS layer count.
 String getSRS(int index)
          Supported SRS at the given index.
 int getSRSCount()
          Supported SRS count.
 String getWMSAbstract()
          Abstract of WMS Service.
 String getWMSName()
          Name of WMS Service.
 String getWMSTitle()
          Title of WMS Service.
 String getWMSVersion()
          Version of WMS Service.
 

Method Detail

getWMSName

String getWMSName()
                  throws IOException,
                         AutomationException
Name of WMS Service.

Remarks

Name is text used to identify a WMS service for machine-to-machine communication.

Product Availability

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

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

getWMSAbstract

String getWMSAbstract()
                      throws IOException,
                             AutomationException
Abstract of WMS Service.

Remarks

The abstract is a narrative description of the WMS service.

Product Availability

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

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

getWMSTitle

String getWMSTitle()
                   throws IOException,
                          AutomationException
Title of WMS Service.

Remarks

Title is the user-friendly text used to identify a WMS service.

Product Availability

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

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

getWMSVersion

String getWMSVersion()
                     throws IOException,
                            AutomationException
Version of WMS Service.

Product Availability

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

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

getLayerDescriptionCount

int getLayerDescriptionCount()
                             throws IOException,
                                    AutomationException
WMS layer count.

Product Availability

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

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

getLayerDescription

IWMSLayerDescription getLayerDescription(int index)
                                         throws IOException,
                                                AutomationException
WMS layer information at the given index.

Product Availability

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

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

getSRSCount

int getSRSCount()
                throws IOException,
                       AutomationException
Supported SRS count.

Product Availability

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

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

getSRS

String getSRS(int index)
              throws IOException,
                     AutomationException
Supported SRS at the given index.

Product Availability

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

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

getImageRequestUrl

String getImageRequestUrl(IArray pLayers,
                          IEnvelope pBoundingBox,
                          int imageWidth,
                          int imageHeight,
                          int bgColor,
                          String responseFormat,
                          boolean drawTransparent)
                          throws IOException,
                                 AutomationException
The URL to download the map image from.

Product Availability

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

Parameters:
pLayers - A reference to a com.esri.arcgis.system.IArray (in)
pBoundingBox - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
imageWidth - The imageWidth (in)
imageHeight - The imageHeight (in)
bgColor - The bgColor (A COM typedef) (in)
responseFormat - The responseFormat (in)
drawTransparent - The drawTransparent (in)
Returns:
The uRL
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureInfoRequestURL

String getFeatureInfoRequestURL(IArray pLayers,
                                IEnvelope pBoundingBox,
                                int imageWidth,
                                int imageHeight,
                                int positionX,
                                int positionY,
                                int featureCount,
                                String responseFormat)
                                throws IOException,
                                       AutomationException
The url to download the feature info from.

Product Availability

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

Parameters:
pLayers - A reference to a com.esri.arcgis.system.IArray (in)
pBoundingBox - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
imageWidth - The imageWidth (in)
imageHeight - The imageHeight (in)
positionX - The positionX (in)
positionY - The positionY (in)
featureCount - The featureCount (in)
responseFormat - The responseFormat (in)
Returns:
The uRL
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImageFormatCount

int getImageFormatCount()
                        throws IOException,
                               AutomationException
Supported GetMap's ImageFormat count.

Product Availability

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

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

getImageFormat

String getImageFormat(int index)
                      throws IOException,
                             AutomationException
Supported GetMap's ImageFormat at the given index.

Product Availability

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

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

getFeatureInfoFormatCount

int getFeatureInfoFormatCount()
                              throws IOException,
                                     AutomationException
Supported FeatureInfoFormat count.

Product Availability

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

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

getFeatureInfoFormat

String getFeatureInfoFormat(int index)
                            throws IOException,
                                   AutomationException
Supported FeatureInfoFormat at the given index.

Product Availability

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

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

getExceptionFormatCount

int getExceptionFormatCount()
                            throws IOException,
                                   AutomationException
Supported exception format count.

Product Availability

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

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

getExceptionFormat

String getExceptionFormat(int index)
                          throws IOException,
                                 AutomationException
Supported exception at the given index.

Product Availability

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

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

getBaseURL

String getBaseURL(String capability,
                  String requestMethod)
                  throws IOException,
                         AutomationException
Base url for given capability and request method.

Product Availability

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

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

fireWMSRequest

void fireWMSRequest(String requestType,
                    String requestURL)
                    throws IOException,
                           AutomationException
Notifies listeners about the URL request made to this WMS Service.

Product Availability

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

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

fireWMSException

void fireWMSException(String requestType,
                      String requestURL,
                      IWMSServiceExceptionHandler pException)
                      throws IOException,
                             AutomationException
Notifies listeners about a valid exception from the WMS Service.

Product Availability

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

Parameters:
requestType - The requestType (in)
requestURL - The requestURL (in)
pException - A reference to a com.esri.arcgis.gisclient.IWMSServiceExceptionHandler (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD