com.esri.arcgis.geoprocessing
Interface IGPScriptTool

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IGPScriptToolProxy

public interface IGPScriptTool
extends java.io.Serializable

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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID03ae1e9c_9f57_44ff_87ad_1910acd6b3cf
static int	xxDummy Deprecated. Internal use only

Method Summary

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

Field Detail

IID03ae1e9c_9f57_44ff_87ad_1910acd6b3cf

static final int IID03ae1e9c_9f57_44ff_87ad_1910acd6b3cf

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getFileName

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

The name of the script file associated with the tool.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFileName

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

The name of the script file associated with the tool.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParameterInfoByRef

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

The parameters associated with the tool.

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

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

The environments associated with the tool.

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

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

The environments associated with the tool.

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

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

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

Returns:

The showWindow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowCommandWindow

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

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

Parameters:

showWindow - The showWindow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.