com.esri.arcgis.carto
Interface ILayerDescription3

All Superinterfaces:

ILayerDescription, ILayerDescription2, Serializable

All Known Implementing Classes:

LayerDescription

public interface ILayerDescription3
extends ILayerDescription2, Serializable

Provides access to the available properties of a layer description object.

Description

This interface is new at ArcGIS 9.3. It supersedes ILayerDescription and ILayerDescription2.

Remarks

Please note the difference of use between IMapLayerInfo and ILayerDescription: Use ILayerDescription to access layer settings that can be changed on the server object without changing the state of the underlying fine-grained ArcObjects that the layer is based on. MapLayerInfo is used to retrieve information about a layer that can only be changed by directly accessing the map document or the fine-grained ArcObjects it is based on.

Use LayerResultOptions when you want to customize a query result.

Layer settings of the Server object can be permanently changed by accessing fine-grained ArcObjects. This is accomplished using IMapServerObjects. This should be done with objects in a non-pooled environment. Changing the state of pooled objects this way will lead to unexpected results. Changes made using IMapServerObjects reside in memory only. They affect only the instance of the map service being accessed. They do not change anything in the original map document (.mxd) saved on disk. These changes exist until the service is restarted or recycled.

Product Availability

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

Method Summary

ILayerResultOptions	getLayerResultOptions() Indicate whether to include and/or modify Geometry.
void	setLayerResultOptionsByRef(ILayerResultOptions layerResultOptions) Indicate whether to include and/or modify Geometry.

Methods inherited from interface com.esri.arcgis.carto.ILayerDescription2

getSelectionBufferSymbol, getSourceID, setSelectionBufferSymbolByRef, setSourceID

Methods inherited from interface com.esri.arcgis.carto.ILayerDescription

getDefinitionExpression, getID, getSelectionBufferDistance, getSelectionColor, getSelectionFeatures, getSelectionSymbol, isScaleSymbols, isSetSelectionSymbol, isShowLabels, isShowSelectionBuffer, isVisible, setDefinitionExpression, setID, setScaleSymbols, setSelectionBufferDistance, setSelectionColorByRef, setSelectionFeatures, setSelectionSymbolByRef, setSetSelectionSymbol, setShowLabels, setShowSelectionBuffer, setVisible

Method Detail

setLayerResultOptionsByRef

void setLayerResultOptionsByRef(ILayerResultOptions layerResultOptions)
                                throws IOException,
                                       AutomationException

Indicate whether to include and/or modify Geometry.

Product Availability

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

Parameters:

layerResultOptions - A reference to a com.esri.arcgis.carto.ILayerResultOptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerResultOptions

ILayerResultOptions getLayerResultOptions()
                                          throws IOException,
                                                 AutomationException

Indicate whether to include and/or modify Geometry.

Remarks

In some cases you may want to customize the results of a MapServer query - for example, when you want field names (instead of field aliases) or data in native format or in some cases you may want improve the performance by limiting or adjusting the geometry being returned.

Since LayerResultsOptions is part of of the LayerDescription, any settings made for LayerResultsOptions will only affect those methods that include the LayerDescription (or MapDescription which contains LayerDescriptions) as a parameter.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.