com.esri.arcgis.geoprocessing
Interface IGPFunctionFactory

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPGlobeFunctionFactory, GpKMLFunctionFactory, GPServerFunctionFactory

public interface IGPFunctionFactory
extends Serializable

Provides access to the properties/methods of a geoprocessing function factory object.

Remarks

The IGPFunctionFactory is a logical grouping of tools. It is registered into the component category CATID_GPFunctionFactories.

The function factory is responsible for handing out the function name objects for each geoprocessing function, in other words it makes a geoprocessing tool accessible. It is required when building geoprocessing functions tools. For more information about using the IGPFuctionFactory refer to the technical document Building Geoprocessing Function Tools.

Product Availability

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

Supported Platforms

Windows


Method Summary
 String getAlias()
          Alias of the geoprocessing function factory.
 IUID getCLSID()
          The class identifier (CLSID) of the geoprocessing function factory.
 IGPFunction getFunction(String name)
          Returns the geoprocessing function object with the given name.
 IEnumGPEnvironment getFunctionEnvironments()
          Returns an enumeration of the geoprocessing environments that the geoprocessing functions managed by this function factory use.
 IGPName getFunctionName(String name)
          Returns the geoprocessing function name object with the given name.
 IEnumGPName getFunctionNames()
          Returns an enumeration of function name objects of all the geoprocessing functions managed by this function factory.
 String getName()
          Name of the geoprocessing function factory.
 

Method Detail

getCLSID

IUID getCLSID()
              throws IOException,
                     AutomationException
The class identifier (CLSID) of the geoprocessing function factory.

Product Availability

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

Supported Platforms

Windows

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.

getName

String getName()
               throws IOException,
                      AutomationException
Name of the geoprocessing function factory.

Product Availability

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

Supported Platforms

Windows

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlias

String getAlias()
                throws IOException,
                       AutomationException
Alias of the geoprocessing function factory.

Product Availability

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

Supported Platforms

Windows

Returns:
The alias
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFunction

IGPFunction getFunction(String name)
                        throws IOException,
                               AutomationException
Returns the geoprocessing function object with the given name.

Product Availability

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

Supported Platforms

Windows

Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPFunction
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFunctionName

IGPName getFunctionName(String name)
                        throws IOException,
                               AutomationException
Returns the geoprocessing function name object with the given name.

Product Availability

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

Supported Platforms

Windows

Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFunctionNames

IEnumGPName getFunctionNames()
                             throws IOException,
                                    AutomationException
Returns an enumeration of function name objects of all the geoprocessing functions managed by this function factory.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumGPName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFunctionEnvironments

IEnumGPEnvironment getFunctionEnvironments()
                                           throws IOException,
                                                  AutomationException
Returns an enumeration of the geoprocessing environments that the geoprocessing functions managed by this function factory use.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumGPEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.