com.esri.arcgis.carto
Interface IMapServerInfo4

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapServerInfo

public interface IMapServerInfo4
extends Serializable

Provides access to the available properties of a map server info object.

Product Availability

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

Method Summary

IColor	getBackgroundColor() The background color of the map (data frame).
IFillSymbol	getBackgroundSymbol() Background symbol of the map (data frame).
IMapServerBookmarks	getBookmarks() The published bookmarks for the map.
String	getCopyrightText() Copyright information associated with the layer.
IMapDescription	getDefaultMapDescription() The default map settings.
String	getDescription() The description of the map (data frame).
IEnvelope	getExtent() The current extent of the map (data frame).
IEnvelope	getFullExtent() The full extent of the map (data frame).
IMapLayerInfos	getMapLayerInfos() A collection of Map Layer Info objects, each containing information about a layer in the map (data frame).
int	getMapUnits() The units for the map (data frame).
double	getMaxScale() The maximum visible scale for the service.
double	getMinScale() The minimum visible scale for the service.
String	getName() The name of the map (data frame).
IStandaloneTableDescriptions	getStandaloneTableDescriptions() Standalone tables descriptions that can passed in to other methods.
IStandaloneTableInfos	getStandaloneTableInfos() Standalone tables infromation in a given map.
boolean	isSupportsDynamicLayers() Indicates if this server supports per-request modification to layer properties.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the map (data frame).

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.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

The description of the map (data frame). This property is set in the General tab of the Data Frame Properties dialog.

Product Availability

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

Returns:

The desc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullExtent

IEnvelope getFullExtent()
                        throws IOException,
                               AutomationException

The full extent of the map (data frame).

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.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The current extent of the map (data frame).

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.

getMapLayerInfos

IMapLayerInfos getMapLayerInfos()
                                throws IOException,
                                       AutomationException

A collection of Map Layer Info objects, each containing information about a layer in the map (data frame).

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IMapLayerInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

The background color of the map (data frame).

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBookmarks

IMapServerBookmarks getBookmarks()
                                 throws IOException,
                                        AutomationException

The published bookmarks for the map.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IMapServerBookmarks

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultMapDescription

IMapDescription getDefaultMapDescription()
                                         throws IOException,
                                                AutomationException

The default map settings.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IMapDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapUnits

int getMapUnits()
                throws IOException,
                       AutomationException

The units for the map (data frame).

Product Availability

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

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundSymbol

IFillSymbol getBackgroundSymbol()
                                throws IOException,
                                       AutomationException

Background symbol of the map (data frame).

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.IFillSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCopyrightText

String getCopyrightText()
                        throws IOException,
                               AutomationException

Copyright information associated with the layer.

Product Availability

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

Returns:

The copyright

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandaloneTableInfos

IStandaloneTableInfos getStandaloneTableInfos()
                                              throws IOException,
                                                     AutomationException

Standalone tables infromation in a given map.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IStandaloneTableInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandaloneTableDescriptions

IStandaloneTableDescriptions getStandaloneTableDescriptions()
                                                            throws IOException,
                                                                   AutomationException

Standalone tables descriptions that can passed in to other methods.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IStandaloneTableDescriptions

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsDynamicLayers

boolean isSupportsDynamicLayers()
                                throws IOException,
                                       AutomationException

Indicates if this server supports per-request modification to layer properties.

Remarks

It returns the value of enableDynamicLayers property set in a service configuration.

When this is true, the MapServer supports the following capabilities:

• modify layer's renderer
• change layer order
• add new layers dynamically from registered workspace
• add or modify layer/table joins

Product Availability

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

Returns:

The supportsDynamicLayers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinScale

double getMinScale()
                   throws IOException,
                          AutomationException

The minimum visible scale for the service.

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.

getMaxScale

double getMaxScale()
                   throws IOException,
                          AutomationException

The maximum visible scale for the service.

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.