com.esri.arcgis.geoprocessing
Class IGPToolExtensionGenProxy

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

public class IGPToolExtensionGenProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPToolExtensionGen, 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
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IGPToolExtensionGenProxy()
           
  IGPToolExtensionGenProxy(Object obj)
           
protected IGPToolExtensionGenProxy(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.
 IGPToolExtensionFactoryGen 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 readExternal(ObjectInput in)
           
 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.
 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

IGPToolExtensionGenProxy

public IGPToolExtensionGenProxy()

IGPToolExtensionGenProxy

public IGPToolExtensionGenProxy(Object obj)
                         throws IOException
Throws:
IOException

IGPToolExtensionGenProxy

protected IGPToolExtensionGenProxy(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 IGPToolExtensionFactoryGen 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 IGPToolExtensionGen
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPToolExtensionFactoryGen
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 IGPToolExtensionGen
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 IGPToolExtensionGen
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 IGPToolExtensionGen
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 IGPToolExtensionGen
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 IGPToolExtensionGen
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 IGPToolExtensionGen
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 IGPToolExtensionGen
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 IGPToolExtensionGen
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 IGPToolExtensionGen
Parameters:
pParam - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)
Returns:
A Variant
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 IGPToolExtensionGen
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 IGPToolExtensionGen
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 IGPToolExtensionGen
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.

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