com.esri.arcgis.geoprocessing
Interface IGPScriptTool2

All Superinterfaces:
Serializable
All Known Implementing Classes:
IGPScriptTool2Proxy

public interface IGPScriptTool2
extends Serializable

Provides access to methods on a geoprocessing script tool object.

Description

This interface is new at ArcGIS 9.3.

Product Availability

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


Method Summary
 String getCodeBlock()
          Validation code block.
 int getExtensionCode()
          Extension code.
 int getProductCode()
          Product code.
 String getSymbologyLayer(String parameterName)
          Layer for Symbology.
 boolean isProductAndExtensionCodes()
          Indicates if the product and/or extension code is set.
 boolean isRunInProc()
          Indicates whether to run the script inproc or not.
 boolean isUseExtensionCode()
          Indicates whether to use the extension code.
 void setCodeBlock(String codeBlock)
          Validation code block.
 void setExtensionCode(int extensionCode)
          Extension code.
 void setProductAndExtensionCodes(boolean productAndExtension)
          Indicates if the product and/or extension code is set.
 void setProductCode(int productCode)
          Product code.
 void setRunInProc(boolean inProc)
          Indicates whether to run the script inproc or not.
 void setSymbologyLayer(String parameterName, String layer)
          Layer for Symbology.
 void setUseExtensionCode(boolean useExtensionCode)
          Indicates whether to use the extension code.
 String testGetParameterInfo()
          Internal validation of GetParameterInfo.
 

Method Detail

isRunInProc

boolean isRunInProc()
                    throws IOException,
                           AutomationException
Indicates whether to run the script inproc or not.

Product Availability

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

Returns:
The inProc
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRunInProc

void setRunInProc(boolean inProc)
                  throws IOException,
                         AutomationException
Indicates whether to run the script inproc or not.

Product Availability

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

Parameters:
inProc - The inProc (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCodeBlock

String getCodeBlock()
                    throws IOException,
                           AutomationException
Validation code block.

Product Availability

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

Returns:
The codeBlock
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCodeBlock

void setCodeBlock(String codeBlock)
                  throws IOException,
                         AutomationException
Validation code block.

Product Availability

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

Parameters:
codeBlock - The codeBlock (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

testGetParameterInfo

String testGetParameterInfo()
                            throws IOException,
                                   AutomationException
Internal validation of GetParameterInfo.

Product Availability

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

Returns:
The pErrMsg
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProductCode

int getProductCode()
                   throws IOException,
                          AutomationException
Product code.

Product Availability

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

Returns:
A com.esri.arcgis.system.esriProductCode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProductCode

void setProductCode(int productCode)
                    throws IOException,
                           AutomationException
Product code.

Product Availability

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

Parameters:
productCode - A com.esri.arcgis.system.esriProductCode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionCode

int getExtensionCode()
                     throws IOException,
                            AutomationException
Extension code.

Product Availability

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

Returns:
A com.esri.arcgis.system.esriProductCode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtensionCode

void setExtensionCode(int extensionCode)
                      throws IOException,
                             AutomationException
Extension code.

Product Availability

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

Parameters:
extensionCode - A com.esri.arcgis.system.esriProductCode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseExtensionCode

boolean isUseExtensionCode()
                           throws IOException,
                                  AutomationException
Indicates whether to use the extension code.

Product Availability

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

Returns:
The useExtensionCode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseExtensionCode

void setUseExtensionCode(boolean useExtensionCode)
                         throws IOException,
                                AutomationException
Indicates whether to use the extension code.

Product Availability

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

Parameters:
useExtensionCode - The useExtensionCode (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isProductAndExtensionCodes

boolean isProductAndExtensionCodes()
                                   throws IOException,
                                          AutomationException
Indicates if the product and/or extension code is set.

Product Availability

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

Returns:
The productAndExtension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProductAndExtensionCodes

void setProductAndExtensionCodes(boolean productAndExtension)
                                 throws IOException,
                                        AutomationException
Indicates if the product and/or extension code is set.

Product Availability

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

Parameters:
productAndExtension - The productAndExtension (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbologyLayer

String getSymbologyLayer(String parameterName)
                         throws IOException,
                                AutomationException
Layer for Symbology.

Product Availability

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

Parameters:
parameterName - The parameterName (in)
Returns:
The layer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbologyLayer

void setSymbologyLayer(String parameterName,
                       String layer)
                       throws IOException,
                              AutomationException
Layer for Symbology.

Product Availability

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

Parameters:
parameterName - The parameterName (in)
layer - The layer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.