com.esri.arcgis.geoprocessing
Interface IMdProcess

All Superinterfaces:

Serializable

All Known Implementing Classes:

MdProcess

public interface IMdProcess
extends Serializable

Provides access to properties/methods of a model process.

Product Availability

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

Method Summary

void	execute(ITrackCancel trackCancel, IGPEnvironmentManager pEnvMgr, IGPMessages messages) Executes the current tool associated with the process using the current parameter values.
IGPEnvironmentManager	getEnvironmentManager() The set of overriding environment values used when validating/executing the process.
IArray	getInputParameters() The collection of input parameter objects used when validating/executing the process.
IArray	getOutputParameters() The collection of output parameter objects used when validating/executing the process.
IMdParameter	getParameter(String name) The parameter object with the specified name.
IArray	getParameters() The collection of parameter objects used when validating/executing the process.
IGPValue	getParameterValue(String name) Returns the value of specified process parameter.
IArray	getPreconditions() Collection of variables that must be executed prior to executing the process.
IGPTool	getTool() The tool object currently associated with the model process.
IGPToolName	getToolName() The tool name object of the tool currently associated with the model process.
boolean	isToolValid() Returns whether or not the current tool associated with the process is valid.
boolean	needsRepair() Returns whether or not the current tool associated with the process needs to be repaired (e.g., the tool parameters have changed).
void	repairParameters() Updates/repairs the processes collection of parameters to match the tool currently associated with the process.
void	setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr) The set of overriding environment values used when validating/executing the process.
void	setParameterValue(String name, IGPValue value) Sets the value of specified process parameter.
void	setPreconditionsByRef(IArray ppValues) Collection of variables that must be executed prior to executing the process.
void	setToolByRef(IGPTool tool) The tool object currently associated with the model process.

Method Detail

getToolName

IGPToolName getToolName()
                        throws IOException,
                               AutomationException

The tool name object of the tool currently associated with the model process.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTool

IGPTool getTool()
                throws IOException,
                       AutomationException

The tool object currently associated with the model process.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolByRef

void setToolByRef(IGPTool tool)
                  throws IOException,
                         AutomationException

The tool object currently associated with the model process.

Product Availability

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

Parameters:

tool - A reference to a com.esri.arcgis.geoprocessing.IGPTool (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

IArray getParameters()
                     throws IOException,
                            AutomationException

The collection of parameter objects used when validating/executing the process.

Product Availability

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

Supported Platforms

Windows

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.

getInputParameters

IArray getInputParameters()
                          throws IOException,
                                 AutomationException

The collection of input parameter objects used when validating/executing the process.

Product Availability

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

Supported Platforms

Windows

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.

getOutputParameters

IArray getOutputParameters()
                           throws IOException,
                                  AutomationException

The collection of output parameter objects used when validating/executing the process.

Product Availability

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

Supported Platforms

Windows

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.

getParameter

IMdParameter getParameter(String name)
                          throws IOException,
                                 AutomationException

The parameter object with the specified name.

Product Availability

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

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnvironmentManager

IGPEnvironmentManager getEnvironmentManager()
                                            throws IOException,
                                                   AutomationException

The set of overriding environment values used when validating/executing the process.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnvironmentManagerByRef

void setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr)
                                throws IOException,
                                       AutomationException

The set of overriding environment values used when validating/executing the process.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterValue

void setParameterValue(String name,
                       IGPValue value)
                       throws IOException,
                              AutomationException

Sets the value of specified process parameter.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterValue

IGPValue getParameterValue(String name)
                           throws IOException,
                                  AutomationException

Returns the value of specified process parameter.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

void execute(ITrackCancel trackCancel,
             IGPEnvironmentManager pEnvMgr,
             IGPMessages messages)
             throws IOException,
                    AutomationException

Executes the current tool associated with the process using the current parameter values.

Product Availability

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

Supported Platforms

Windows

Parameters:

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.

isToolValid

boolean isToolValid()
                    throws IOException,
                           AutomationException

Returns whether or not the current tool associated with the process is valid.

Product Availability

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

Supported Platforms

Windows

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

needsRepair

boolean needsRepair()
                    throws IOException,
                           AutomationException

Returns whether or not the current tool associated with the process needs to be repaired (e.g., the tool parameters have changed).

Product Availability

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

Supported Platforms

Windows

Returns:

The needsRepair

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

repairParameters

void repairParameters()
                      throws IOException,
                             AutomationException

Updates/repairs the processes collection of parameters to match the tool currently associated with the process.

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.

getPreconditions

IArray getPreconditions()
                        throws IOException,
                               AutomationException

Collection of variables that must be executed prior to executing the process.

Product Availability

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

Supported Platforms

Windows

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.

setPreconditionsByRef

void setPreconditionsByRef(IArray ppValues)
                           throws IOException,
                                  AutomationException

Collection of variables that must be executed prior to executing the process.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.