com.esri.arcgis.geoprocessing
Class IGPModelToolProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geoprocessing.IGPModelToolProxy
All Implemented Interfaces:
IGPModelTool, Externalizable, Serializable

public class IGPModelToolProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPModelTool, Serializable

Provides access to methods on a geoprocessing model tool object.

Product Availability

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

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  IGPModelToolProxy()
           
  IGPModelToolProxy(Object obj)
           
protected IGPModelToolProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 removeListener(String iidStr, Object theListener)
           
 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.
 
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

noncastable

public boolean noncastable
Constructor Detail

IGPModelToolProxy

public IGPModelToolProxy()

IGPModelToolProxy

public IGPModelToolProxy(Object obj)
                  throws IOException
Throws:
IOException

IGPModelToolProxy

protected IGPModelToolProxy(Object obj,
                            String iid)
                     throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getModel

public 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

Specified by:
getModel in interface IGPModelTool
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

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

Specified by:
setModelByRef in interface IGPModelTool
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

public 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

Specified by:
getDiagramProperties in interface IGPModelTool
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

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

Specified by:
setDiagramPropertiesByRef in interface IGPModelTool
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

public 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

Specified by:
addParameter in interface IGPModelTool
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeParameter

public 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

Specified by:
removeParameter in interface IGPModelTool
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findParameter

public 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

Specified by:
findParameter in interface IGPModelTool
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

public 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

Specified by:
generateDefaultParameters in interface IGPModelTool
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

renameElement

public 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

Specified by:
renameElement in interface IGPModelTool
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

public void clearParameters()
                     throws IOException,
                            AutomationException
Clear parameters.

Product Availability

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

Supported Platforms

Windows

Specified by:
clearParameters in interface IGPModelTool
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteIntermediateData

public void deleteIntermediateData()
                            throws IOException,
                                   AutomationException
Delete intermediate data.

Product Availability

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

Supported Platforms

Windows

Specified by:
deleteIntermediateData in interface IGPModelTool
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIntermediateVariables

public IEnumMdVariable getIntermediateVariables()
                                         throws IOException,
                                                AutomationException
Get intermediate variables.

Product Availability

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

Supported Platforms

Windows

Specified by:
getIntermediateVariables in interface IGPModelTool
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.