com.esri.arcgis.gisclient
Interface IWMSServiceDescription

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IWMSServiceDescriptionProxy, WMSConnection

public interface IWMSServiceDescription
extends java.io.Serializable

COM Interface 'IWMSServiceDescription'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriGISClient.olb'

Description: 'Provides access to members give access to WMSServiceDescription information.' 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	IIDde0e6ebf_8abf_4700_b9f5_b097e14c0e51
static int	xxDummy Deprecated. Internal use only

Method Summary

void	fireWMSException(java.lang.String requestType, java.lang.String requestURL, IWMSServiceExceptionHandler pException) Notifies listeners about a valid exception from the WMS Service.
void	fireWMSRequest(java.lang.String requestType, java.lang.String requestURL) Notifies listeners about the URL request made to this WMS Service.
java.lang.String	getBaseURL(java.lang.String capability, java.lang.String requestMethod) Base url for given capability and request method.
java.lang.String	getExceptionFormat(int index) Supported exception at the given index.
int	getExceptionFormatCount() Supported exception format count.
java.lang.String	getFeatureInfoFormat(int index) Supported FeatureInfoFormat at the given index.
int	getFeatureInfoFormatCount() Supported FeatureInfoFormat count.
java.lang.String	getFeatureInfoRequestURL(IArray pLayers, IEnvelope pBoundingBox, int imageWidth, int imageHeight, int positionX, int positionY, int featureCount, java.lang.String responseFormat) The url to download the feature info from.
java.lang.String	getImageFormat(int index) Supported GetMap's ImageFormat at the given index.
int	getImageFormatCount() Supported GetMap's ImageFormat count.
java.lang.String	getImageRequestUrl(IArray pLayers, IEnvelope pBoundingBox, int imageWidth, int imageHeight, int bgColor, java.lang.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.
java.lang.String	getSRS(int index) Supported SRS at the given index.
int	getSRSCount() Supported SRS count.
java.lang.String	getWMSAbstract() Abstract of WMS Service.
java.lang.String	getWMSName() Name of WMS Service.
java.lang.String	getWMSTitle() Title of WMS Service.
java.lang.String	getWMSVersion() Version of WMS Service.

Field Detail

IIDde0e6ebf_8abf_4700_b9f5_b097e14c0e51

static final int IIDde0e6ebf_8abf_4700_b9f5_b097e14c0e51

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

getWMSName

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

Name of WMS Service.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWMSAbstract

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

Abstract of WMS Service.

Returns:

The esri_abstract

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWMSTitle

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

Title of WMS Service.

Returns:

The title

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWMSVersion

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

Version of WMS Service.

Returns:

The title

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerDescriptionCount

int getLayerDescriptionCount()
                             throws java.io.IOException,
                                    AutomationException

WMS layer count.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerDescription

IWMSLayerDescription getLayerDescription(int index)
                                         throws java.io.IOException,
                                                AutomationException

WMS layer information at the given index.

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSRSCount

int getSRSCount()
                throws java.io.IOException,
                       AutomationException

Supported SRS count.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSRS

java.lang.String getSRS(int index)
                        throws java.io.IOException,
                               AutomationException

Supported SRS at the given index.

Parameters:

index - The index (in)

Returns:

The sRS

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImageRequestUrl

java.lang.String getImageRequestUrl(IArray pLayers,
                                    IEnvelope pBoundingBox,
                                    int imageWidth,
                                    int imageHeight,
                                    int bgColor,
                                    java.lang.String responseFormat,
                                    boolean drawTransparent)
                                    throws java.io.IOException,
                                           AutomationException

The URL to download the map image from.

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:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureInfoRequestURL

java.lang.String getFeatureInfoRequestURL(IArray pLayers,
                                          IEnvelope pBoundingBox,
                                          int imageWidth,
                                          int imageHeight,
                                          int positionX,
                                          int positionY,
                                          int featureCount,
                                          java.lang.String responseFormat)
                                          throws java.io.IOException,
                                                 AutomationException

The url to download the feature info from.

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:

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

AutomationException - If the ArcObject component throws an exception.

getImageFormatCount

int getImageFormatCount()
                        throws java.io.IOException,
                               AutomationException

Supported GetMap's ImageFormat count.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImageFormat

java.lang.String getImageFormat(int index)
                                throws java.io.IOException,
                                       AutomationException

Supported GetMap's ImageFormat at the given index.

Parameters:

index - The index (in)

Returns:

The imageFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureInfoFormatCount

int getFeatureInfoFormatCount()
                              throws java.io.IOException,
                                     AutomationException

Supported FeatureInfoFormat count.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureInfoFormat

java.lang.String getFeatureInfoFormat(int index)
                                      throws java.io.IOException,
                                             AutomationException

Supported FeatureInfoFormat at the given index.

Parameters:

index - The index (in)

Returns:

The imageFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExceptionFormatCount

int getExceptionFormatCount()
                            throws java.io.IOException,
                                   AutomationException

Supported exception format count.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExceptionFormat

java.lang.String getExceptionFormat(int index)
                                    throws java.io.IOException,
                                           AutomationException

Supported exception at the given index.

Parameters:

index - The index (in)

Returns:

The exceptionFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBaseURL

java.lang.String getBaseURL(java.lang.String capability,
                            java.lang.String requestMethod)
                            throws java.io.IOException,
                                   AutomationException

Base url for given capability and request method.

Parameters:

capability - The capability (in)

requestMethod - The requestMethod (in)

Returns:

The baseURL

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fireWMSRequest

void fireWMSRequest(java.lang.String requestType,
                    java.lang.String requestURL)
                    throws java.io.IOException,
                           AutomationException

Notifies listeners about the URL request made to this WMS Service.

Parameters:

requestType - The requestType (in)

requestURL - The requestURL (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fireWMSException

void fireWMSException(java.lang.String requestType,
                      java.lang.String requestURL,
                      IWMSServiceExceptionHandler pException)
                      throws java.io.IOException,
                             AutomationException

Notifies listeners about a valid exception from the WMS Service.

Parameters:

requestType - The requestType (in)

requestURL - The requestURL (in)

pException - A reference to a com.esri.arcgis.gisclient.IWMSServiceExceptionHandler (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.