com.esri.arcgis.gisclient
Interface IWMSLayerDescription

All Superinterfaces:

Serializable

All Known Implementing Classes:

IWMSLayerDescriptionProxy

public interface IWMSLayerDescription
extends Serializable

Provides access to members give access to WMSLayerDescription information.

Remarks

IWMSLayerDescription provides access to members that describe the capabilities of a WMS layer.

Product Availability

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

Method Summary

String	getAbstract() Abstract of the WMS layer.
void	getBoundingBox(int index, IEnvelope[] envelope, String[] srsCode) Minimum bounding extents of the layer data along with the applicable SRS.
int	getBoundingBoxCount() Number of bounding extents of the layer.
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.
double	getFixedHeight() Fixed height at which server is able to display the layer.
double	getFixedWidth() Fixed width at which server is able to display the layer.
String	getImageFormat(int index) Supported GetMap's ImageFormat at the given index.
int	getImageFormatCount() Supported GetMap's ImageFormat count.
int	getIsCascaded() Indicates the number of times the layer has been reserved.
IEnvelope	getLatLongBoundingBox() Minimum bounding extent of the layer data in EPSG:4326.
IWMSLayerDescription	getLayerDescription(int index) WMSLayerDescription at a given index.
int	getLayerDescriptionCount() Number of WMSLayerDescriptions.
String	getName() Name of WMS layer.
double	getScaleHintMax() Suggested maximum scale of the WMS layer.
double	getScaleHintMin() Suggested minimimum scale for the WMS layer.
String	getSRS(int index) Supproted SRS at the given index.
int	getSRSCount() Supported SRS count.
IWMSLayerStyleDescription	getStyleDescription(int index) Style of the layer at the given index.
int	getStyleDescriptionCount() Number of styles in the layer.
String	getTitle() Title of WMS layer.
String	getWMSVersion() WMS Version.
boolean	isOpaque() Indicates whether the layer is opaque or transparent in terms of the area that gets drawn.
boolean	isQueryable() Indicates whether the layer is queryable.
boolean	isSubsettable() Indicates whether or not the server will be able to crop the data to a geographic area smaller than its enclosing bounding box.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of WMS layer.

Remarks

Name is text used to identify a WMS layer 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.

getTitle

String getTitle()
                throws IOException,
                       AutomationException

Title of WMS layer.

Remarks

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

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.

getAbstract

String getAbstract()
                   throws IOException,
                          AutomationException

Abstract of the WMS layer.

Remarks

The abstract is a narrative description of the WMS layer.

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.

isQueryable

boolean isQueryable()
                    throws IOException,
                           AutomationException

Indicates whether the layer is queryable.

Product Availability

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

Returns:

The isQuaryable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOpaque

boolean isOpaque()
                 throws IOException,
                        AutomationException

Indicates whether the layer is opaque or transparent in terms of the area that gets drawn.

Product Availability

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

Returns:

The isOpaque

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIsCascaded

int getIsCascaded()
                  throws IOException,
                         AutomationException

Indicates the number of times the layer has been reserved.

Product Availability

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

Returns:

The isCascaded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSubsettable

boolean isSubsettable()
                      throws IOException,
                             AutomationException

Indicates whether or not the server will be able to crop the data to a geographic area smaller than its enclosing bounding box.

Product Availability

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

Returns:

The isSubsettable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFixedWidth

double getFixedWidth()
                     throws IOException,
                            AutomationException

Fixed width at which server is able to display the layer. If this is zero, server can display the layer at any resolution.

Product Availability

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

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFixedHeight

double getFixedHeight()
                      throws IOException,
                             AutomationException

Fixed height at which server is able to display the layer. If this is zero, server can display the layer at any resolution.

Product Availability

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

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDescriptionCount

int getLayerDescriptionCount()
                             throws IOException,
                                    AutomationException

Number of WMSLayerDescriptions.

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

WMSLayerDescription at a 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.

getScaleHintMin

double getScaleHintMin()
                       throws IOException,
                              AutomationException

Suggested minimimum scale for the WMS layer.

Product Availability

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

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScaleHintMax

double getScaleHintMax()
                       throws IOException,
                              AutomationException

Suggested maximum scale of the WMS layer.

Product Availability

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

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLatLongBoundingBox

IEnvelope getLatLongBoundingBox()
                                throws IOException,
                                       AutomationException

Minimum bounding extent of the layer data in EPSG:4326.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundingBoxCount

int getBoundingBoxCount()
                        throws IOException,
                               AutomationException

Number of bounding extents of the layer.

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.

getBoundingBox

void getBoundingBox(int index,
                    IEnvelope[] envelope,
                    String[] srsCode)
                    throws IOException,
                           AutomationException

Minimum bounding extents of the layer data along with the applicable SRS.

Product Availability

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

Parameters:

index - The index (in)

envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)

srsCode - The srsCode (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyleDescriptionCount

int getStyleDescriptionCount()
                             throws IOException,
                                    AutomationException

Number of styles in the layer.

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.

getStyleDescription

IWMSLayerStyleDescription getStyleDescription(int index)
                                              throws IOException,
                                                     AutomationException

Style of the layer 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.IWMSLayerStyleDescription

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

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

getWMSVersion

String getWMSVersion()
                     throws IOException,
                            AutomationException

WMS Version.

Product Availability

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

Returns:

The wMSVersion

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.