com.esri.arcgis.globecore
Class IGlobeHelperPub2Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.globecore.IGlobeHelperPubProxy
          extended by com.esri.arcgis.globecore.IGlobeHelperPub2Proxy
All Implemented Interfaces:
IGlobeHelperPub, IGlobeHelperPub2, Externalizable, Serializable

public class IGlobeHelperPub2Proxy
extends IGlobeHelperPubProxy
implements IGlobeHelperPub2, 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.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IGlobeHelperPub2Proxy()
           
  IGlobeHelperPub2Proxy(Object obj)
           
protected IGlobeHelperPub2Proxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.globecore.IGlobeHelperPubProxy
addGlobeProperties, adjustGCS360, createAllCacheSubDirectoriesInPath, deleteAllowedLayerCachesInGlobeCacheDirectory, deleteLayerCacheDirectory, findGlobeLayerProperties, setGroupLayerCache, syncExtrusionProperties
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.globecore.IGlobeHelperPub
addGlobeProperties, adjustGCS360, createAllCacheSubDirectoriesInPath, deleteAllowedLayerCachesInGlobeCacheDirectory, deleteLayerCacheDirectory, findGlobeLayerProperties, setGroupLayerCache, syncExtrusionProperties
 

Constructor Detail

IGlobeHelperPub2Proxy

public IGlobeHelperPub2Proxy()

IGlobeHelperPub2Proxy

public IGlobeHelperPub2Proxy(Object obj)
                      throws IOException
Throws:
IOException

IGlobeHelperPub2Proxy

protected IGlobeHelperPub2Proxy(Object obj,
                                String iid)
                         throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class IGlobeHelperPubProxy
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class IGlobeHelperPubProxy
Throws:
IOException

getGroupLayerFromCacheName

public 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.

Specified by:
getGroupLayerFromCacheName in interface IGlobeHelperPub2
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

public 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.

Specified by:
loadServerObject in interface IGlobeHelperPub2
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

public 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.

Specified by:
loadNamedServerObject in interface IGlobeHelperPub2
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

public 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.

Specified by:
getListofServerObjects in interface IGlobeHelperPub2
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

public Object encryptCredentials(String credentials)
                          throws IOException,
                                 AutomationException
Encrypts given a user credentail.

Product Availability

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

Specified by:
encryptCredentials in interface IGlobeHelperPub2
Parameters:
credentials - The credentials (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException