com.esri.arcgis.geoprocessing
Class IGPServerSyncProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geoprocessing.IGPServerSyncProxy

All Implemented Interfaces:

IGPServerSync, Externalizable, Serializable

public class IGPServerSyncProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPServerSync, Serializable

Provides access to the methods of the geoprocessing server.

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

	IGPServerSyncProxy()
	IGPServerSyncProxy(Object obj)
protected	IGPServerSyncProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IGPResult	execute(String toolName, IGPValues pValues, IGPResultOptions pOptions, IPropertySet pEnvValues) Executes the specified tool with the supplied values and options and returns the results.
IGPToolInfo	getToolInfo(String toolName) Returns the tool information of the specified tool name.
IGPToolInfos	getToolInfos() Returns the tool information of the available tools.
IStringArray	getToolNames() Returns the names of the available tools.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	writeExternal(ObjectOutput out)

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

Constructor Detail

IGPServerSyncProxy

public IGPServerSyncProxy()

IGPServerSyncProxy

public IGPServerSyncProxy(Object obj)
                   throws IOException

Throws:

IOException

IGPServerSyncProxy

protected IGPServerSyncProxy(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 com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getToolNames

public IStringArray getToolNames()
                          throws IOException,
                                 AutomationException

Returns the names of the available tools.

Product Availability

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

Specified by:

getToolNames in interface IGPServerSync

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolInfo

public IGPToolInfo getToolInfo(String toolName)
                        throws IOException,
                               AutomationException

Returns the tool information of the specified tool name.

Product Availability

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

Specified by:

getToolInfo in interface IGPServerSync

Parameters:

toolName - The toolName (in)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPToolInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolInfos

public IGPToolInfos getToolInfos()
                          throws IOException,
                                 AutomationException

Returns the tool information of the available tools.

Product Availability

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

Specified by:

getToolInfos in interface IGPServerSync

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPToolInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public IGPResult execute(String toolName,
                         IGPValues pValues,
                         IGPResultOptions pOptions,
                         IPropertySet pEnvValues)
                  throws IOException,
                         AutomationException

Executes the specified tool with the supplied values and options and returns the results.

Product Availability

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

Specified by:

execute in interface IGPServerSync

Parameters:

toolName - The toolName (in)

pValues - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)

pOptions - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)

pEnvValues - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPResult

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