com.esri.arcgis.geoprocessing
Class IGPFunctionProxy

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

All Implemented Interfaces:

IGPFunction, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

IGPFunction2Proxy

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

Description: 'Provides access to the properties/methods of a geoprocessing function 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 =

public class IGPFunctionProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPFunction, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGPFunctionProxy() Deprecated. For internal use only
	IGPFunctionProxy(java.lang.Object obj) Deprecated.
protected	IGPFunctionProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IGPFunctionProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IGPFunctionProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Deprecated.
void	execute(IArray paramvalues, ITrackCancel trackCancel, IGPEnvironmentManager envMgr, IGPMessages message) Deprecated. Executes the geoprocessing function using the given array of parameter values.
IUID	getDialogCLSID() Deprecated. The class identifier (CLSID) of the custom dialog object to use when invoking the geoprocessing function.
java.lang.String	getDisplayName() Deprecated. Displayed name of the geoprocessing function.
IName	getFullName() Deprecated. The function name object of the geoprocessing function.
int	getHelpContext() Deprecated. The context identifier of the topic within the help file for this function object.
java.lang.String	getHelpFile() Deprecated. Name of the (CHM) file containing help information for this function object.
java.lang.String	getMetadataFile() Deprecated. Name of the (XML) file containing the default metadata for this function object.
java.lang.String	getName() Deprecated. Name of the geoprocessing function.
IArray	getParameterInfo() Deprecated. The list of parameters accepted by the geoprocessing function.
java.lang.Object	getRenderer(IGPParameter pParam) Deprecated. Returns the custom renderer to use for the specified parameter.
boolean	isLicensed() Deprecated. Returns whether the geoprocessing function has all necessary licenses in order to execute.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
IGPMessages	validate(IArray paramvalues, boolean updateValues, IGPEnvironmentManager envMgr) Deprecated. Validates the given array of parameter 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

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

IGPFunctionProxy

public IGPFunctionProxy(java.lang.String CLSID,
                        java.lang.String host,
                        com.esri.arcgis.interop.AuthInfo authInfo)
                 throws java.net.UnknownHostException,
                        java.io.IOException

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

IGPFunctionProxy

public IGPFunctionProxy()

Deprecated.

For internal use only

IGPFunctionProxy

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

Deprecated.

Throws:

java.io.IOException

IGPFunctionProxy

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

Deprecated.

Throws:

java.io.IOException

IGPFunctionProxy

protected IGPFunctionProxy(java.lang.String CLSID,
                           java.lang.String iid,
                           java.lang.String host,
                           com.esri.arcgis.interop.AuthInfo authInfo)
                    throws java.io.IOException

Deprecated.

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

Deprecated.

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

Deprecated.

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

getName

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

Deprecated.

Name of the geoprocessing function.

Remarks

The Name property sets the name of a function tool. This name appears when using the function tool at the command line or in scripting. It must be unique within a given toolbox and must not contain any spaces.

Product Availability

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

Supported Platforms

Windows

Specified by:

getName in interface IGPFunction

Returns:

The name

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

Deprecated.

Displayed name of the geoprocessing function.

Remarks

The DisplayName property sets the user-friendly name of a function tool. It is displayed in the graphic user interface of the ArcToolbox window. The DisplayName can be internationalized.

Product Availability

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

Supported Platforms

Windows

Specified by:

getDisplayName in interface IGPFunction

Returns:

The name

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

Deprecated.

The list of parameters accepted by the geoprocessing function.

Remarks

The ParameterInfo property is the place where a function tool's parameters are defined. It returns an IArray of parameter objects (IGPParameter); these objects define the characteristics of the input and output parameters.

Product Availability

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

Supported Platforms

Windows

Specified by:

getParameterInfo in interface IGPFunction

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

Deprecated.

The class identifier (CLSID) of the custom dialog object to use when invoking the geoprocessing function.

Remarks

The DialogCLSID property is used to overwrite the default system tool dialog's look and feel. By default, Toolbox creates a dialog based upon the parameters returned by the ParameterInfo property.

Product Availability

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

Supported Platforms

Windows

Specified by:

getDialogCLSID in interface IGPFunction

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.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

Deprecated.

The function name object of the geoprocessing function.

Remarks

The FullName property is the function name object for the GPFunction. It is created and returned by the GPFunctionFactory. The GPFunctionFactory must first be created before the FullName property can be implemented. Refer to IGPFunctionFactory for more detail.

Product Availability

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

Supported Platforms

Windows

Specified by:

getFullName in interface IGPFunction

Returns:

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

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

Deprecated.

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

Remarks

The HelpFile porperty stores the path to a .chm file which contains a description of the tool parameters and explains the tool's operation and usage.

Product Availability

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

Supported Platforms

Windows

Specified by:

getHelpFile in interface IGPFunction

Returns:

The file

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

Deprecated.

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

Remarks

The HelpContext property is a unique ID for the help topic from a HelpFile.

Product Availability

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

Supported Platforms

Windows

Specified by:

getHelpContext in interface IGPFunction

Returns:

The context

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMetadataFile

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

Deprecated.

Name of the (XML) file containing the default metadata for this function object.

Description

The MetadataFile property stores the name of a .xml file with the default metadata for a function tool. The .xml file supplies parameter descriptions in the help panel of a tool dialog. If no .chm file is provided through the HelpFile property, a tool's help is based on the .xml file's content.

Product Availability

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

Supported Platforms

Windows

Specified by:

getMetadataFile in interface IGPFunction

Returns:

The file

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

Deprecated.

Returns whether the geoprocessing function has all necessary licenses in order to execute.

Remarks

The IsLicensed property is used to check if a function tool is licensed to execute in the active application.

Product Availability

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

Supported Platforms

Windows

Specified by:

isLicensed in interface IGPFunction

Returns:

The isLicensed

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

Deprecated.

Returns the custom renderer to use for the specified parameter.

Remarks

The GetRenderer property is used to set a custom renderer for a function tool's output.

Product Availability

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

Supported Platforms

Windows

Specified by:

getRenderer in interface IGPFunction

Parameters:

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

Returns:

A Variant

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 envMgr)
                     throws java.io.IOException,
                            AutomationException

Deprecated.

Validates the given array of parameter values.

Remarks

The Validate method checks that a function tool's set of parameter values are of the expected number, data type, and value.

Product Availability

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

Supported Platforms

Windows

Specified by:

validate in interface IGPFunction

Parameters:

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

updateValues - The updateValues (in)

envMgr - 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 envMgr,
                    IGPMessages message)
             throws java.io.IOException,
                    AutomationException

Deprecated.

Executes the geoprocessing function using the given array of parameter values.

Product Availability

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

Supported Platforms

Windows

Specified by:

execute in interface IGPFunction

Parameters:

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

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

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

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