com.esri.arcgis.geoprocessing
Interface IGPModelTool

All Superinterfaces:

Serializable

All Known Implementing Classes:

IGPModelToolProxy

public interface IGPModelTool
extends Serializable

Provides access to methods on a geoprocessing model tool object.

Product Availability

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

Method Summary

void	addParameter(String name) Adds a parameter to the model tool.
void	clearParameters() Clear parameters.
void	deleteIntermediateData() Delete intermediate data.
IGPParameter	findParameter(String name) Finds a parameter in the model tool.
void	generateDefaultParameters() Finds a parameter in the model tool.
IMdDiagramProperties	getDiagramProperties() The diagram properties object associated with the tool.
IEnumMdVariable	getIntermediateVariables() Get intermediate variables.
IMdModel	getModel() The model object associated with the tool.
void	removeParameter(String name) Removes a parameter from the model tool.
void	renameElement(String oldName, String newName) Rename element.
void	setDiagramPropertiesByRef(IMdDiagramProperties diagramProperties) The diagram properties object associated with the tool.
void	setModelByRef(IMdModel model) The model object associated with the tool.

Method Detail

getModel

IMdModel getModel()
                  throws IOException,
                         AutomationException

The model object associated with the tool.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setModelByRef

void setModelByRef(IMdModel model)
                   throws IOException,
                          AutomationException

The model object associated with the tool.

Product Availability

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

Parameters:

model - A reference to a com.esri.arcgis.geoprocessing.IMdModel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDiagramProperties

IMdDiagramProperties getDiagramProperties()
                                          throws IOException,
                                                 AutomationException

The diagram properties object associated with the tool.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDiagramPropertiesByRef

void setDiagramPropertiesByRef(IMdDiagramProperties diagramProperties)
                               throws IOException,
                                      AutomationException

The diagram properties object associated with the tool.

Product Availability

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

Parameters:

diagramProperties - A reference to a com.esri.arcgis.geoprocessing.IMdDiagramProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addParameter

void addParameter(String name)
                  throws IOException,
                         AutomationException

Adds a parameter to the model tool.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeParameter

void removeParameter(String name)
                     throws IOException,
                            AutomationException

Removes a parameter from the model tool.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findParameter

IGPParameter findParameter(String name)
                           throws IOException,
                                  AutomationException

Finds a parameter in the model tool.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateDefaultParameters

void generateDefaultParameters()
                               throws IOException,
                                      AutomationException

Finds a parameter in the model tool.

Product Availability

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

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

renameElement

void renameElement(String oldName,
                   String newName)
                   throws IOException,
                          AutomationException

Rename element.

Product Availability

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

Supported Platforms

Windows

Parameters:

oldName - The oldName (in)

newName - The newName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearParameters

void clearParameters()
                     throws IOException,
                            AutomationException

Clear parameters.

Product Availability

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

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteIntermediateData

void deleteIntermediateData()
                            throws IOException,
                                   AutomationException

Delete intermediate data.

Product Availability

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

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIntermediateVariables

IEnumMdVariable getIntermediateVariables()
                                         throws IOException,
                                                AutomationException

Get intermediate variables.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.