com.esri.arcgis.globecore
Interface IGlobeHelperPub2

All Superinterfaces:

IGlobeHelperPub, Serializable

All Known Implementing Classes:

IGlobeHelperPub2Proxy

public interface IGlobeHelperPub2
extends IGlobeHelperPub, Serializable

an interface with some standard Globe Utility functions.

Description

This interface is new at ArcGIS 9.3. It supersedes IGlobeHelperPub.

Product Availability

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

Method Summary

Object	encryptCredentials(String credentials) Encrypts given a user credentail.
IGroupLayer	getGroupLayerFromCacheName(String groupCacheName) Gets Group Layer given a cache name.
IEnumBSTR	getListofServerObjects(String bsfullServerName, String[] bsServiceURL, String[] bsServiceName, String[] bsServiceType, String[] bsUsername, Object[] vPassword, IEnumBSTR[] ppTypes) Gets a flat list of server objects.
IEnumLayer	loadNamedServerObject(String bsServerName, String bsServerObjectname, String bsServiceType, String bsUsername, Object vPassword, IGlobe pGlobe, boolean bRequestLoadAnimation) Loads the named arcgis service into the globe.
void	loadServerObject(String bsfullServerName, String bsUsername, Object vPassword, IGlobe ipGlobe, String[] bsServerObjectname, IEnumBSTR[] ppEnum) Loads the arcgis service into the globe.

Methods inherited from interface com.esri.arcgis.globecore.IGlobeHelperPub

addGlobeProperties, adjustGCS360, createAllCacheSubDirectoriesInPath, deleteAllowedLayerCachesInGlobeCacheDirectory, deleteLayerCacheDirectory, findGlobeLayerProperties, setGroupLayerCache, syncExtrusionProperties

Method Detail

getGroupLayerFromCacheName

IGroupLayer getGroupLayerFromCacheName(String groupCacheName)
                                       throws IOException,
                                              AutomationException

Gets Group Layer given a cache name.

Product Availability

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

Parameters:

groupCacheName - The groupCacheName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadServerObject

void loadServerObject(String bsfullServerName,
                      String bsUsername,
                      Object vPassword,
                      IGlobe ipGlobe,
                      String[] bsServerObjectname,
                      IEnumBSTR[] ppEnum)
                      throws IOException,
                             AutomationException

Loads the arcgis service into the globe.

Description

Use this method if you know the fully qualified name of the service.

Product Availability

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

Parameters:

bsfullServerName - The bsfullServerName (in)

bsUsername - The bsUsername (in)

vPassword - A Variant (in)

ipGlobe - A reference to a com.esri.arcgis.globecore.IGlobe (in)

bsServerObjectname - The bsServerObjectname (in/out: use single element array)

ppEnum - A reference to a com.esri.arcgis.system.IEnumBSTR (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadNamedServerObject

IEnumLayer loadNamedServerObject(String bsServerName,
                                 String bsServerObjectname,
                                 String bsServiceType,
                                 String bsUsername,
                                 Object vPassword,
                                 IGlobe pGlobe,
                                 boolean bRequestLoadAnimation)
                                 throws IOException,
                                        AutomationException

Loads the named arcgis service into the globe.

Description

Use this method to add a Globe/Map service to globe. The method returns an IEnumLayer which is the list of layers in the service.

Product Availability

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

Parameters:

bsServerName - The bsServerName (in)

bsServerObjectname - The bsServerObjectname (in)

bsServiceType - The bsServiceType (in)

bsUsername - The bsUsername (in)

vPassword - A Variant (in)

pGlobe - A reference to a com.esri.arcgis.globecore.IGlobe (in)

bRequestLoadAnimation - The bRequestLoadAnimation (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getListofServerObjects

IEnumBSTR getListofServerObjects(String bsfullServerName,
                                 String[] bsServiceURL,
                                 String[] bsServiceName,
                                 String[] bsServiceType,
                                 String[] bsUsername,
                                 Object[] vPassword,
                                 IEnumBSTR[] ppTypes)
                                 throws IOException,
                                        AutomationException

Gets a flat list of server objects. If full name is provided returns the ServiceURL, ServiceName and SeviceType.

Product Availability

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

Parameters:

bsfullServerName - The bsfullServerName (in)

bsServiceURL - The bsServiceURL (out: use single element array)

bsServiceName - The bsServiceName (out: use single element array)

bsServiceType - The bsServiceType (in/out: use single element array)

bsUsername - The bsUsername (in/out: use single element array)

vPassword - A Variant (in/out: use single element array)

ppTypes - A reference to a com.esri.arcgis.system.IEnumBSTR (out: use single element array)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

encryptCredentials

Object encryptCredentials(String credentials)
                          throws IOException,
                                 AutomationException

Encrypts given a user credentail.

Product Availability

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

Parameters:

credentials - The credentials (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.