com.esri.arcgis.geoprocessing
Class IGPScriptToolProxy

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

All Implemented Interfaces:

IGPScriptTool, java.io.Externalizable, java.io.Serializable

public class IGPScriptToolProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPScriptTool, java.io.Serializable

Internal use class Proxy for COM Interface 'IGPScriptTool'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'Provides access to methods on a geoprocessing script tool object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.geoprocessing.IGPScriptTool

IID, IID03ae1e9c_9f57_44ff_87ad_1910acd6b3cf

Constructor Summary

	IGPScriptToolProxy() For internal use only
	IGPScriptToolProxy(java.lang.Object obj)
protected	IGPScriptToolProxy(java.lang.Object obj, java.lang.String iid)
	IGPScriptToolProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IGPScriptToolProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
IArray	getEnvironments() The environments associated with the tool.
java.lang.String	getFileName() The name of the script file associated with the tool.
boolean	isShowCommandWindow() Indicates whether or not to display a command window when executing.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setEnvironmentsByRef(IArray environments) The environments associated with the tool.
void	setFileName(java.lang.String name) The name of the script file associated with the tool.
void	setParameterInfoByRef(IArray rhs1) The parameters associated with the tool.
void	setShowCommandWindow(boolean showWindow) Indicates whether or not to display a command window when executing.

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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IGPScriptToolProxy

public IGPScriptToolProxy(java.lang.String CLSID,
                          java.lang.String host,
                          com.esri.arcgis.interop.AuthInfo authInfo)
                   throws java.net.UnknownHostException,
                          java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IGPScriptToolProxy

public IGPScriptToolProxy()

For internal use only

IGPScriptToolProxy

public IGPScriptToolProxy(java.lang.Object obj)
                   throws java.io.IOException

Throws:

java.io.IOException

IGPScriptToolProxy

protected IGPScriptToolProxy(java.lang.Object obj,
                             java.lang.String iid)
                      throws java.io.IOException

Throws:

java.io.IOException

IGPScriptToolProxy

protected IGPScriptToolProxy(java.lang.String CLSID,
                             java.lang.String iid,
                             java.lang.String host,
                             com.esri.arcgis.interop.AuthInfo authInfo)
                      throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

getFileName

public java.lang.String getFileName()
                             throws java.io.IOException,
                                    AutomationException

The name of the script file associated with the tool.

Specified by:

getFileName in interface IGPScriptTool

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFileName

public void setFileName(java.lang.String name)
                 throws java.io.IOException,
                        AutomationException

The name of the script file associated with the tool.

Specified by:

setFileName in interface IGPScriptTool

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterInfoByRef

public void setParameterInfoByRef(IArray rhs1)
                           throws java.io.IOException,
                                  AutomationException

The parameters associated with the tool.

Specified by:

setParameterInfoByRef in interface IGPScriptTool

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnvironments

public IArray getEnvironments()
                       throws java.io.IOException,
                              AutomationException

The environments associated with the tool.

Specified by:

getEnvironments in interface IGPScriptTool

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnvironmentsByRef

public void setEnvironmentsByRef(IArray environments)
                          throws java.io.IOException,
                                 AutomationException

The environments associated with the tool.

Specified by:

setEnvironmentsByRef in interface IGPScriptTool

Parameters:

environments - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowCommandWindow

public boolean isShowCommandWindow()
                            throws java.io.IOException,
                                   AutomationException

Indicates whether or not to display a command window when executing.

Specified by:

isShowCommandWindow in interface IGPScriptTool

Returns:

The showWindow

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowCommandWindow

public void setShowCommandWindow(boolean showWindow)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether or not to display a command window when executing.

Specified by:

setShowCommandWindow in interface IGPScriptTool

Parameters:

showWindow - The showWindow (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.