com.esri.arcgis.carto
Interface IMapServerObjects

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMapServerObjectsProxy, MapServer

public interface IMapServerObjects
extends java.io.Serializable

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

Description: 'Provides access to core objects contained within the map document.' 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	IID651521f3_aaff_42b9_8c2d_1980625a13bf
static int	xxDummy Deprecated. Internal use only

Method Summary

void	applyMapDescription(IMapDescription mapDescription, IImageDisplay mapDisplay) Applies the current state of the map description to the map server object.
ILayer	getLayer(java.lang.String mapName, int layerID) The layer specified by the map name and layer ID.
IMap	getMap(java.lang.String mapName) The map corresponding to the specified map name.
IPageLayout	getPageLayout() The page layout object for the current map document.
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.

Field Detail

IID651521f3_aaff_42b9_8c2d_1980625a13bf

static final int IID651521f3_aaff_42b9_8c2d_1980625a13bf

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

getMap

IMap getMap(java.lang.String mapName)
            throws java.io.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).

Parameters:

mapName - The mapName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(java.lang.String mapName,
                int layerID)
                throws java.io.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.

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageLayout

IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException

The page layout object for the current map document.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThumbnail

Picture getThumbnail()
                     throws java.io.IOException,
                            AutomationException

The thumbnail stored in the map document.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshServerObjects

void refreshServerObjects()
                          throws java.io.IOException,
                                 AutomationException

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applyMapDescription

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

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

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.