com.esri.arcgis.geoprocessing
Interface IGPScriptTool

All Superinterfaces:

Serializable

All Known Implementing Classes:

IGPScriptToolProxy

public interface IGPScriptTool
extends Serializable

Provides access to methods on a geoprocessing script tool object.

Product Availability

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

Method Summary

IArray	getEnvironments() The environments associated with the tool.
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(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.

Method Detail

getFileName

String getFileName()
                   throws IOException,
                          AutomationException

The name of the script file associated with the tool.

Product Availability

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

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFileName

void setFileName(String name)
                 throws IOException,
                        AutomationException

The name of the script file associated with the tool.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterInfoByRef

void setParameterInfoByRef(IArray rhs1)
                           throws IOException,
                                  AutomationException

The parameters associated with the tool.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnvironments

IArray getEnvironments()
                       throws IOException,
                              AutomationException

The environments associated with the tool.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnvironmentsByRef

void setEnvironmentsByRef(IArray environments)
                          throws IOException,
                                 AutomationException

The environments associated with the tool.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowCommandWindow

boolean isShowCommandWindow()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Supported Platforms

Windows

Returns:

The showWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowCommandWindow

void setShowCommandWindow(boolean showWindow)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Supported Platforms

Windows

Parameters:

showWindow - The showWindow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.