com.esri.arcgis.geoprocessing
Class IGPToolExtensionProxy

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

All Implemented Interfaces:

IGPToolExtension, Externalizable, Serializable

public class IGPToolExtensionProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPToolExtension, Serializable

Provides access to methods on a custom geoprocessing tool extension.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGPToolExtensionProxy()
	IGPToolExtensionProxy(Object obj)
protected	IGPToolExtensionProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
boolean	canEditSource() Returns whether or not the source for the tool extension can be edited.
void	execute(IArray paramvalues, ITrackCancel trackCancel, IGPEnvironmentManager pEnvMgr, IGPMessages messages) Executes the tool extension given the set of parameter values.
IGPCustomToolHelper	getCustomToolHelper() The custom tool helper object associated with the tool extension.
IUID	getDialogCLSID() The CLSID of a custom dialog class to enter/edit parameter values for custom tools associated with this tool extension.
IArray	getParameterInfo() The parameters required to execute the custom tool associated with this tool extension.
Object	getRenderer(IGPParameter pParam) Returns a custom renderer for a given parameter.
IGPToolExtensionFactory	getToolExtensionFactory() The factory object associated with this tool extension.
boolean	isLicensed() Returns whether or not the tool extension has all necessary product licenses to be executed.
boolean	isLicensedForProduct() Returns whether or not the tool extension can be executed within the current application product.
boolean	isValid() Returns whether or not the tool extension is can be executed.
void	removeListener(String iidStr, Object theListener)
void	setCustomToolHelperByRef(IGPCustomToolHelper helper) The custom tool helper object associated with the tool extension.
void	synchronizeMetadata(int action, int interval, IPropertySet metadata) Updates the given metadata property set with the current tool extension properties.
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

noncastable

public boolean noncastable

Constructor Detail

IGPToolExtensionProxy

public IGPToolExtensionProxy()

IGPToolExtensionProxy

public IGPToolExtensionProxy(Object obj)
                      throws IOException

Throws:

IOException

IGPToolExtensionProxy

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

getToolExtensionFactory

public IGPToolExtensionFactory getToolExtensionFactory()
                                                throws IOException,
                                                       AutomationException

The factory object associated with this tool extension.

Product Availability

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

Specified by:

getToolExtensionFactory in interface IGPToolExtension

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomToolHelper

public IGPCustomToolHelper getCustomToolHelper()
                                        throws IOException,
                                               AutomationException

The custom tool helper object associated with the tool extension.

Product Availability

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

Specified by:

getCustomToolHelper in interface IGPToolExtension

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomToolHelperByRef

public void setCustomToolHelperByRef(IGPCustomToolHelper helper)
                              throws IOException,
                                     AutomationException

The custom tool helper object associated with the tool extension.

Product Availability

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

Specified by:

setCustomToolHelperByRef in interface IGPToolExtension

Parameters:

helper - A reference to a com.esri.arcgis.geoprocessing.IGPCustomToolHelper (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDialogCLSID

public IUID getDialogCLSID()
                    throws IOException,
                           AutomationException

The CLSID of a custom dialog class to enter/edit parameter values for custom tools associated with this tool extension.

Product Availability

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

Specified by:

getDialogCLSID in interface IGPToolExtension

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterInfo

public IArray getParameterInfo()
                        throws IOException,
                               AutomationException

The parameters required to execute the custom tool associated with this tool extension.

Product Availability

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

Specified by:

getParameterInfo in interface IGPToolExtension

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.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Returns whether or not the tool extension is can be executed.

Product Availability

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

Specified by:

isValid in interface IGPToolExtension

Returns:

The valid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLicensedForProduct

public boolean isLicensedForProduct()
                             throws IOException,
                                    AutomationException

Returns whether or not the tool extension can be executed within the current application product.

Product Availability

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

Specified by:

isLicensedForProduct in interface IGPToolExtension

Returns:

The isLicensed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLicensed

public boolean isLicensed()
                   throws IOException,
                          AutomationException

Returns whether or not the tool extension has all necessary product licenses to be executed.

Product Availability

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

Specified by:

isLicensed in interface IGPToolExtension

Returns:

The isLicensed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canEditSource

public boolean canEditSource()
                      throws IOException,
                             AutomationException

Returns whether or not the source for the tool extension can be edited.

Product Availability

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

Specified by:

canEditSource in interface IGPToolExtension

Returns:

The canEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

public Object getRenderer(IGPParameter pParam)
                   throws IOException,
                          AutomationException

Returns a custom renderer for a given parameter.

Product Availability

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

Specified by:

getRenderer in interface IGPToolExtension

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

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 IOException,
                            AutomationException

Validates the given set of values.

Product Availability

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

Specified by:

validate in interface IGPToolExtension

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:

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 IOException,
                    AutomationException

Executes the tool extension given the set of parameter values.

Product Availability

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

Specified by:

execute in interface IGPToolExtension

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

synchronizeMetadata

public void synchronizeMetadata(int action,
                                int interval,
                                IPropertySet metadata)
                         throws IOException,
                                AutomationException

Updates the given metadata property set with the current tool extension properties.

Product Availability

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

Specified by:

synchronizeMetadata in interface IGPToolExtension

Parameters:

action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)

interval - The interval (in)

metadata - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.