com.esri.arcgis.globecore
Interface IGlobeServerLayer

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobeServerLayer

public interface IGlobeServerLayer
extends Serializable

Provides access to the available properties of a globe server layer object.

Product Availability

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

Method Summary

IAGSServerObjectName	getConnectionServerName() Provides access to members that supply server object name information.
String	getDisplayField() Primary display field.
IGlobeLayerInfo	getGlobeLayerInfo() Provides access to the available properties of a globe layer info object.
IGlobeServer	getGlobeServer() Provides access to the GlobeServer object.
int	getGlobeServerLayerID() The GlobeServer layer identifier.
String	getGlobeServerLayerName() The name of the GlobeServer layer.
IGlobeLegendInfo	getLegendInfo() Provides access to members that control legend information provided by a renderer.
IPoint	getSearchLocation() The location to be used when an identify is performed on a Globe Server Layer.
int	getSearchOID() The feature OID used as a hint when an identify is performed on a Globe Server Layer.
IGlobeServer	getThreadedGlobeServer() Provides access to a threaded GlobeServer object.
boolean	isComposite() Indicates if the layer supports ICompositeLayer to contain sublayers.
void	serverConnect(IAGSServerObjectName soName, IGlobeServer pGlobeServer, String layerName, int layerID) Connects to the Server given the GlobeServer Object, layer name and layer ID.
void	setDisplayField(String fieldName) Primary display field.
void	setIsComposite(boolean pbComposite) Indicates if the layer supports ICompositeLayer to contain sublayers.
void	setSearchLocation(IPoint loc) The location to be used when an identify is performed on a Globe Server Layer.
void	setSearchOID(int pOid) The feature OID used as a hint when an identify is performed on a Globe Server Layer.

Method Detail

serverConnect

void serverConnect(IAGSServerObjectName soName,
                   IGlobeServer pGlobeServer,
                   String layerName,
                   int layerID)
                   throws IOException,
                          AutomationException

Connects to the Server given the GlobeServer Object, layer name and layer ID.

Product Availability

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

Parameters:

soName - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

pGlobeServer - A reference to a com.esri.arcgis.globecore.IGlobeServer (in)

layerName - The layerName (in)

layerID - The layerID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionServerName

IAGSServerObjectName getConnectionServerName()
                                             throws IOException,
                                                    AutomationException

Provides access to members that supply server object name information.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeServerLayerName

String getGlobeServerLayerName()
                               throws IOException,
                                      AutomationException

The name of the GlobeServer layer.

Product Availability

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

Returns:

The layerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeServerLayerID

int getGlobeServerLayerID()
                          throws IOException,
                                 AutomationException

The GlobeServer layer identifier. This ID is used throughout to uniquely identify the layer for all requests.

Product Availability

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

Returns:

The pLayerID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendInfo

IGlobeLegendInfo getLegendInfo()
                               throws IOException,
                                      AutomationException

Provides access to members that control legend information provided by a renderer.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeLegendInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeLayerInfo

IGlobeLayerInfo getGlobeLayerInfo()
                                  throws IOException,
                                         AutomationException

Provides access to the available properties of a globe layer info object.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeLayerInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeServer

IGlobeServer getGlobeServer()
                            throws IOException,
                                   AutomationException

Provides access to the GlobeServer object.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeServer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThreadedGlobeServer

IGlobeServer getThreadedGlobeServer()
                                    throws IOException,
                                           AutomationException

Provides access to a threaded GlobeServer object.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeServer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchOID

void setSearchOID(int pOid)
                  throws IOException,
                         AutomationException

The feature OID used as a hint when an identify is performed on a Globe Server Layer.

Product Availability

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

Parameters:

pOid - The pOid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchOID

int getSearchOID()
                 throws IOException,
                        AutomationException

The feature OID used as a hint when an identify is performed on a Globe Server Layer.

Product Availability

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

Returns:

The pOid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchLocation

void setSearchLocation(IPoint loc)
                       throws IOException,
                              AutomationException

The location to be used when an identify is performed on a Globe Server Layer.

Product Availability

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

Parameters:

loc - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchLocation

IPoint getSearchLocation()
                         throws IOException,
                                AutomationException

The location to be used when an identify is performed on a Globe Server Layer.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayField

void setDisplayField(String fieldName)
                     throws IOException,
                            AutomationException

Primary display field.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayField

String getDisplayField()
                       throws IOException,
                              AutomationException

Primary display field.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsComposite

void setIsComposite(boolean pbComposite)
                    throws IOException,
                           AutomationException

Indicates if the layer supports ICompositeLayer to contain sublayers.

Product Availability

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

Parameters:

pbComposite - The pbComposite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isComposite

boolean isComposite()
                    throws IOException,
                           AutomationException

Indicates if the layer supports ICompositeLayer to contain sublayers.

Product Availability

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

Returns:

The pbComposite

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.