com.esri.arcgis.geoprocessing
Class IGPToolProxy

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

All Implemented Interfaces:

IGPTool, java.io.Externalizable, java.io.Serializable

public class IGPToolProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPTool, java.io.Serializable

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

Description: 'Provides access to methods on a geoprocessing 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.IGPTool

IID, IID252c58fd_4042_4628_a9d0_de54c158ba55

Constructor Summary

	IGPToolProxy() For internal use only
	IGPToolProxy(java.lang.Object obj)
protected	IGPToolProxy(java.lang.Object obj, java.lang.String iid)
	IGPToolProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IGPToolProxy(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)
boolean	canAlter() Returns whether or not the properties of the tool can be modified.
boolean	canEditSource() Returns whether or not the source (i.e., definition) of the tool can be modified.
boolean	editProperties(int hParent, IGPEnvironmentManager gPEnvMgr) Presents a modal dialog to edit the tool's properties.
void	execute(IArray paramvalues, ITrackCancel trackCancel, IGPEnvironmentManager pEnvMgr, IGPMessages messages) Executes the tool with the given set of values.
java.lang.String	getDescription() The description of the tool.
IUID	getDialogCLSID() The class identifier of the custom dialog to use for this tool.
java.lang.String	getDisplayName() The display name of the tool.
int	getHelpContext() The context identifier of the topic within the help file for this tool.
java.lang.String	getHelpFile() Name of the (CHM) file containing help information for this tool.
java.lang.String	getName() The name of the tool.
IArray	getParameterInfo() The set of parameters required to execute the tool.
java.lang.String	getPathName() The path of the tool object.
java.lang.Object	getRenderer(IGPParameter pParam) Returns the renderer associated with the specified parameter.
IGPToolbox	getToolbox() The toolbox of the tool.
java.lang.String	getToolCategory() The tool category.
int	getToolType() The type of tool.
boolean	isDeleted() Indicates if the tool has been deleted.
boolean	isLicensed() Returns whether the tool is licensed to be executed.
boolean	isLicensedForProduct() Returns whether the tool is part of the current product.
boolean	isRelativePaths() Indicates if path names are stored relative to the tool/toolbox.
boolean	isValid() Returns whether the tool is capable of being executed/edited.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setDescription(java.lang.String description) The description of the tool.
void	setDisplayName(java.lang.String displayName) The display name of the tool.
void	setHelpContext(int context) The context identifier of the topic within the help file for this tool.
void	setHelpFile(java.lang.String file) Name of the (CHM) file containing help information for this tool.
void	setName(java.lang.String displayName) The name of the tool.
void	setRelativePaths(boolean relPaths) Indicates if path names are stored relative to the tool/toolbox.
void	setToolCategory(java.lang.String category) The tool category.
void	store() Stores the current state of the tool to the toolbox.
IGPMessages	validate(IArray paramvalues, boolean updateValues, IGPEnvironmentManager pEnvMgr) Validates the given set of values.

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

IGPToolProxy

public IGPToolProxy(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

IGPToolProxy

public IGPToolProxy()

For internal use only

IGPToolProxy

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

Throws:

java.io.IOException

IGPToolProxy

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

Throws:

java.io.IOException

IGPToolProxy

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

getName

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

The name of the tool.

Specified by:

getName in interface IGPTool

Returns:

The displayName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String displayName)
             throws java.io.IOException,
                    AutomationException

The name of the tool.

Specified by:

setName in interface IGPTool

Parameters:

displayName - The displayName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayName

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

The display name of the tool.

Specified by:

getDisplayName in interface IGPTool

Returns:

The displayName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayName

public void setDisplayName(java.lang.String displayName)
                    throws java.io.IOException,
                           AutomationException

The display name of the tool.

Specified by:

setDisplayName in interface IGPTool

Parameters:

displayName - The displayName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

The description of the tool.

Specified by:

getDescription in interface IGPTool

Returns:

The description

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException

The description of the tool.

Specified by:

setDescription in interface IGPTool

Parameters:

description - The description (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolCategory

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

The tool category.

Specified by:

getToolCategory in interface IGPTool

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setToolCategory

public void setToolCategory(java.lang.String category)
                     throws java.io.IOException,
                            AutomationException

The tool category.

Specified by:

setToolCategory in interface IGPTool

Parameters:

category - The category (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolbox

public IGPToolbox getToolbox()
                      throws java.io.IOException,
                             AutomationException

The toolbox of the tool.

Specified by:

getToolbox in interface IGPTool

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPToolbox

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolType

public int getToolType()
                throws java.io.IOException,
                       AutomationException

The type of tool.

Specified by:

getToolType in interface IGPTool

Returns:

A com.esri.arcgis.geoprocessing.esriGPToolType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

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

Returns whether the tool is capable of being executed/edited.

Specified by:

isValid in interface IGPTool

Returns:

The valid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLicensedForProduct

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

Returns whether the tool is part of the current product.

Specified by:

isLicensedForProduct in interface IGPTool

Returns:

The isLicensed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLicensed

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

Returns whether the tool is licensed to be executed.

Specified by:

isLicensed in interface IGPTool

Returns:

The isLicensed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDeleted

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

Indicates if the tool has been deleted.

Specified by:

isDeleted in interface IGPTool

Returns:

The deleted

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canAlter

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

Returns whether or not the properties of the tool can be modified.

Specified by:

canAlter in interface IGPTool

Returns:

The canAlter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canEditSource

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

Returns whether or not the source (i.e., definition) of the tool can be modified.

Specified by:

canEditSource in interface IGPTool

Returns:

The canEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameterInfo

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

The set of parameters required to execute the tool.

Specified by:

getParameterInfo in interface IGPTool

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.

getDialogCLSID

public IUID getDialogCLSID()
                    throws java.io.IOException,
                           AutomationException

The class identifier of the custom dialog to use for this tool.

Specified by:

getDialogCLSID in interface IGPTool

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

store

public void store()
           throws java.io.IOException,
                  AutomationException

Stores the current state of the tool to the toolbox.

Specified by:

store in interface IGPTool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validate

public IGPMessages validate(IArray paramvalues,
                            boolean updateValues,
                            IGPEnvironmentManager pEnvMgr)
                     throws java.io.IOException,
                            AutomationException

Validates the given set of values.

Specified by:

validate in interface IGPTool

Parameters:

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

updateValues - The updateValues (in)

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(IArray paramvalues,
                    ITrackCancel trackCancel,
                    IGPEnvironmentManager pEnvMgr,
                    IGPMessages messages)
             throws java.io.IOException,
                    AutomationException

Executes the tool with the given set of values.

Specified by:

execute in interface IGPTool

Parameters:

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

editProperties

public boolean editProperties(int hParent,
                              IGPEnvironmentManager gPEnvMgr)
                       throws java.io.IOException,
                              AutomationException

Presents a modal dialog to edit the tool's properties.

Specified by:

editProperties in interface IGPTool

Parameters:

hParent - The hParent (A COM typedef) (in)

gPEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

Returns:

The ok

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRenderer

public java.lang.Object getRenderer(IGPParameter pParam)
                             throws java.io.IOException,
                                    AutomationException

Returns the renderer associated with the specified parameter.

Specified by:

getRenderer in interface IGPTool

Parameters:

pParam - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPathName

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

The path of the tool object.

Specified by:

getPathName in interface IGPTool

Returns:

The pathName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRelativePaths

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

Indicates if path names are stored relative to the tool/toolbox.

Specified by:

isRelativePaths in interface IGPTool

Returns:

The relPaths

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativePaths

public void setRelativePaths(boolean relPaths)
                      throws java.io.IOException,
                             AutomationException

Indicates if path names are stored relative to the tool/toolbox.

Specified by:

setRelativePaths in interface IGPTool

Parameters:

relPaths - The relPaths (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpFile

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

Name of the (CHM) file containing help information for this tool.

Specified by:

getHelpFile in interface IGPTool

Returns:

The file

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHelpFile

public void setHelpFile(java.lang.String file)
                 throws java.io.IOException,
                        AutomationException

Name of the (CHM) file containing help information for this tool.

Specified by:

setHelpFile in interface IGPTool

Parameters:

file - The file (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpContext

public int getHelpContext()
                   throws java.io.IOException,
                          AutomationException

The context identifier of the topic within the help file for this tool.

Specified by:

getHelpContext in interface IGPTool

Returns:

The context

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHelpContext

public void setHelpContext(int context)
                    throws java.io.IOException,
                           AutomationException

The context identifier of the topic within the help file for this tool.

Specified by:

setHelpContext in interface IGPTool

Parameters:

context - The context (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.