com.esri.arcgis.geoprocessing
Class IGPToolExtensionProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geoprocessing.IGPToolExtensionProxy
All Implemented Interfaces:
IGPToolExtension, java.io.Externalizable, java.io.Serializable

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

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

Description: 'Provides access to methods on a custom geoprocessing tool extension.' 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.IGPToolExtension
IID, IIDad1cb977_d8b6_4d54_8c85_86d6e533649b
 
Constructor Summary
  IGPToolExtensionProxy()
          For internal use only
  IGPToolExtensionProxy(java.lang.Object obj)
           
protected IGPToolExtensionProxy(java.lang.Object obj, java.lang.String iid)
           
  IGPToolExtensionProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IGPToolExtensionProxy(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 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.
 java.lang.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(java.lang.String iidStr, java.lang.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

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IGPToolExtensionProxy

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

IGPToolExtensionProxy

public IGPToolExtensionProxy()
For internal use only


IGPToolExtensionProxy

public IGPToolExtensionProxy(java.lang.Object obj)
                      throws java.io.IOException
Throws:
java.io.IOException

IGPToolExtensionProxy

protected IGPToolExtensionProxy(java.lang.Object obj,
                                java.lang.String iid)
                         throws java.io.IOException
Throws:
java.io.IOException

IGPToolExtensionProxy

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

getToolExtensionFactory

public IGPToolExtensionFactory getToolExtensionFactory()
                                                throws java.io.IOException,
                                                       AutomationException
The factory object associated with this tool extension.

Specified by:
getToolExtensionFactory in interface IGPToolExtension
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPToolExtensionFactory
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomToolHelper

public IGPCustomToolHelper getCustomToolHelper()
                                        throws java.io.IOException,
                                               AutomationException
The custom tool helper object associated with the tool extension.

Specified by:
getCustomToolHelper in interface IGPToolExtension
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPCustomToolHelper
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomToolHelperByRef

public void setCustomToolHelperByRef(IGPCustomToolHelper helper)
                              throws java.io.IOException,
                                     AutomationException
The custom tool helper object associated with the tool extension.

Specified by:
setCustomToolHelperByRef in interface IGPToolExtension
Parameters:
helper - A reference to a com.esri.arcgis.geoprocessing.IGPCustomToolHelper (in)
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 CLSID of a custom dialog class to enter/edit parameter values for custom tools associated with this tool extension.

Specified by:
getDialogCLSID in interface IGPToolExtension
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.

getParameterInfo

public IArray getParameterInfo()
                        throws java.io.IOException,
                               AutomationException
The parameters required to execute the custom tool associated with this tool extension.

Specified by:
getParameterInfo in interface IGPToolExtension
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.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException
Returns whether or not the tool extension is can be executed.

Specified by:
isValid in interface IGPToolExtension
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 or not the tool extension can be executed within the current application product.

Specified by:
isLicensedForProduct in interface IGPToolExtension
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 or not the tool extension has all necessary product licenses to be executed.

Specified by:
isLicensed in interface IGPToolExtension
Returns:
The isLicensed
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 for the tool extension can be edited.

Specified by:
canEditSource in interface IGPToolExtension
Returns:
The canEdit
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 a custom renderer for a given parameter.

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:
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 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:
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 extension given the set of parameter values.

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:
java.io.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 java.io.IOException,
                                AutomationException
Updates the given metadata property set with the current tool extension properties.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.