com.esri.arcgis.carto
Interface IMapServerObjects3

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMapServerObjects3Proxy, MapServer

public interface IMapServerObjects3
extends Serializable

Provides access to core objects contained within the map document.

Product Availability

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

Method Summary

void	applyMapDescription(IMapDescription mapDescription, IImageDisplay mapDisplay) Applies the current state of the map description to the map server object.
ILayer	getLayer(String mapName, int layerID) The layer specified by the map name and layer ID.
int	getLayerID(String mapName, ILayer pLayer) The layer specified by the map name and layer ID.
IMap	getMap(String mapName) The map corresponding to the specified map name.
IPageLayout	getPageLayout() The page layout object for the current map document.
ITable	getStandaloneTable(String mapName, int standaloneTableID) The table specified by the map name and table ID.
int	getStandaloneTableID(String mapName, ITable pTable) The layer specified by the map name and standalone table ID.
Picture	getThumbnail() The thumbnail stored in the map document.
void	refreshServerObjects() Updates the server info based on the current state of the underlying fine-grained objects.

Method Detail

getStandaloneTableID

int getStandaloneTableID(String mapName,
                         ITable pTable)
                         throws IOException,
                                AutomationException

The layer specified by the map name and standalone table ID. If the mapName is blank, the default map (active data frame) will be assumed.

Product Availability

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

Parameters:

mapName - The mapName (in)

pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandaloneTable

ITable getStandaloneTable(String mapName,
                          int standaloneTableID)
                          throws IOException,
                                 AutomationException

The table specified by the map name and table ID. If the mapName is blank, the default map (active data frame) will be assumed.

Product Availability

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

Parameters:

mapName - The mapName (in)

standaloneTableID - The standaloneTableID (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerID

int getLayerID(String mapName,
               ILayer pLayer)
               throws IOException,
                      AutomationException

The layer specified by the map name and layer ID. If the mapName is blank, the default map (active data frame) will be assumed.

Product Availability

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

Parameters:

mapName - The mapName (in)

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMap

IMap getMap(String mapName)
            throws IOException,
                   AutomationException

The map corresponding to the specified map name. Pass in a blank string for mapName to get the default map (active data frame).

Product Availability

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

Parameters:

mapName - The mapName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(String mapName,
                int layerID)
                throws IOException,
                       AutomationException

The layer specified by the map name and layer ID. If the mapName is blank, the default map (active data frame) will be assumed.

Product Availability

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

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageLayout

IPageLayout getPageLayout()
                          throws IOException,
                                 AutomationException

The page layout object for the current map document.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnail

Picture getThumbnail()
                     throws IOException,
                            AutomationException

The thumbnail stored in the map document.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshServerObjects

void refreshServerObjects()
                          throws IOException,
                                 AutomationException

Updates the server info based on the current state of the underlying fine-grained objects.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyMapDescription

void applyMapDescription(IMapDescription mapDescription,
                         IImageDisplay mapDisplay)
                         throws IOException,
                                AutomationException

Applies the current state of the map description to the map server object.

Product Availability

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

Parameters:

mapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)

mapDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.