com.esri.arcgis.geoprocessing
Class IGPScriptTool2Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geoprocessing.IGPScriptTool2Proxy
All Implemented Interfaces:
IGPScriptTool2, Externalizable, Serializable

public class IGPScriptTool2Proxy
extends com.esri.arcgis.interop.Dispatch
implements IGPScriptTool2, 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.

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
  IGPScriptTool2Proxy()
           
  IGPScriptTool2Proxy(Object obj)
           
protected IGPScriptTool2Proxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 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.
 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

IGPScriptTool2Proxy

public IGPScriptTool2Proxy()

IGPScriptTool2Proxy

public IGPScriptTool2Proxy(Object obj)
                    throws IOException
Throws:
IOException

IGPScriptTool2Proxy

protected IGPScriptTool2Proxy(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

isRunInProc

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

Specified by:
isRunInProc in interface IGPScriptTool2
Returns:
The inProc
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRunInProc

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

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

getCodeBlock

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

Product Availability

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

Specified by:
getCodeBlock in interface IGPScriptTool2
Returns:
The codeBlock
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCodeBlock

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

Product Availability

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

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

testGetParameterInfo

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

Product Availability

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

Specified by:
testGetParameterInfo in interface IGPScriptTool2
Returns:
The pErrMsg
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProductCode

public int getProductCode()
                   throws IOException,
                          AutomationException
Product code.

Product Availability

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

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

setProductCode

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

Product Availability

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

Specified by:
setProductCode in interface IGPScriptTool2
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

public int getExtensionCode()
                     throws IOException,
                            AutomationException
Extension code.

Product Availability

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

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

setExtensionCode

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

Product Availability

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

Specified by:
setExtensionCode in interface IGPScriptTool2
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

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

Product Availability

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

Specified by:
isUseExtensionCode in interface IGPScriptTool2
Returns:
The useExtensionCode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseExtensionCode

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

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

isProductAndExtensionCodes

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

Specified by:
isProductAndExtensionCodes in interface IGPScriptTool2
Returns:
The productAndExtension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProductAndExtensionCodes

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

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

getSymbologyLayer

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

Product Availability

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

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

setSymbologyLayer

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

Product Availability

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

Specified by:
setSymbologyLayer in interface IGPScriptTool2
Parameters:
parameterName - The parameterName (in)
layer - The layer (in)
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