Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geoprocessing
Interface IMdProcess

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IMdProcessProxy, MdProcess
public interface IMdProcess
extends java.io.Serializable

COM Interface 'IMdProcess'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'Provides access to properties/methods of a model process.' 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 =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID890d0dd1_0f70_4235_9d01_09de87ec949c
           
static int xxDummy
          Deprecated. Internal use only
 
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(java.lang.String name)
          The parameter object with the specified name.
 IArray getParameters()
          The collection of parameter objects used when validating/executing the process.
 IGPValue getParameterValue(java.lang.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(java.lang.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.
 

Field Detail

IID890d0dd1_0f70_4235_9d01_09de87ec949c

static final int IID890d0dd1_0f70_4235_9d01_09de87ec949c
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getToolName

IGPToolName getToolName()
                        throws java.io.IOException,
                               AutomationException
The tool name object of the tool currently associated with the model process.

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

getTool

IGPTool getTool()
                throws java.io.IOException,
                       AutomationException
The tool object currently associated with the model process.

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

setToolByRef

void setToolByRef(IGPTool tool)
                  throws java.io.IOException,
                         AutomationException
The tool object currently associated with the model process.

Parameters:
tool - A reference to a com.esri.arcgis.geoprocessing.IGPTool (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameters

IArray getParameters()
                     throws java.io.IOException,
                            AutomationException
The collection of parameter objects used when validating/executing the process.

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.

getInputParameters

IArray getInputParameters()
                          throws java.io.IOException,
                                 AutomationException
The collection of input parameter objects used when validating/executing the process.

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.

getOutputParameters

IArray getOutputParameters()
                           throws java.io.IOException,
                                  AutomationException
The collection of output parameter objects used when validating/executing the process.

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.

getParameter

IMdParameter getParameter(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException
The parameter object with the specified name.

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

getEnvironmentManager

IGPEnvironmentManager getEnvironmentManager()
                                            throws java.io.IOException,
                                                   AutomationException
The set of overriding environment values used when validating/executing the process.

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

setEnvironmentManagerByRef

void setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr)
                                throws java.io.IOException,
                                       AutomationException
The set of overriding environment values used when validating/executing the process.

Parameters:
ppEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParameterValue

void setParameterValue(java.lang.String name,
                       IGPValue value)
                       throws java.io.IOException,
                              AutomationException
Sets the value of specified process parameter.

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

getParameterValue

IGPValue getParameterValue(java.lang.String name)
                           throws java.io.IOException,
                                  AutomationException
Returns the value of specified process parameter.

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

execute

void execute(ITrackCancel trackCancel,
             IGPEnvironmentManager pEnvMgr,
             IGPMessages messages)
             throws java.io.IOException,
                    AutomationException
Executes the current tool associated with the process using the current parameter values.

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

isToolValid

boolean isToolValid()
                    throws java.io.IOException,
                           AutomationException
Returns whether or not the current tool associated with the process is valid.

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

needsRepair

boolean needsRepair()
                    throws java.io.IOException,
                           AutomationException
Returns whether or not the current tool associated with the process needs to be repaired (e.g., the tool parameters have changed).

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

repairParameters

void repairParameters()
                      throws java.io.IOException,
                             AutomationException
Updates/repairs the processes collection of parameters to match the tool currently associated with the process.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPreconditions

IArray getPreconditions()
                        throws java.io.IOException,
                               AutomationException
Collection of variables that must be executed prior to executing the process.

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.

setPreconditionsByRef

void setPreconditionsByRef(IArray ppValues)
                           throws java.io.IOException,
                                  AutomationException
Collection of variables that must be executed prior to executing the process.

Parameters:
ppValues - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD