com.esri.arcgis.geoprocessing
Class MdProcess

java.lang.Object
  com.esri.arcgis.geoprocessing.MdProcess

All Implemented Interfaces:

IGPToolboxEvents, IMdElement, IMdProcess, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable, EventListener

public class MdProcess
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IClone, IMdElement, IMdProcess, IPersistStream, IXMLSerialize, IGPToolboxEvents, Externalizable

Model process object that represents a specific invokation of a particular geoprocessing tool.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

MdProcess()
Constructs a MdProcess using ArcGIS Engine.

MdProcess(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MdProcess theMdProcess = (MdProcess) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	execute(ITrackCancel trackCancel, IGPEnvironmentManager pEnvMgr, IGPMessages messages) Executes the current tool associated with the process using the current parameter values.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IEnumMdElement	getDependents(int direction, int connectionType) Returns an enumeration of model elements that are dependent on the model element in the given direction and of the given connection type.
IGPEnvironmentManager	getEnvironmentManager() The set of overriding environment values used when validating/executing the process.
int	getID() Unique identifier of the model element.
IArray	getInputParameters() The collection of input parameter objects used when validating/executing the process.
IGPMessages	getMessages() Returns the messages returned from the last call to Validate().
IMdModel	getModel() The model the model element is contained within.
String	getName() Name of the model element.
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getState() The state of the model element.
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.
int	hashCode() the hashcode for this object
boolean	isAltered() Indicates if the model element has been altered by the user.
boolean	isCurrent() Indicates if the model element is current (i.e., has been created).
boolean	isDependentOn(IMdElement pMdElement, int direction, int connectionType) Returns whether or not the model element is dependent on the given model element in the given direction of the given connection type.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isMarked() Indicates if the model element has been marked for validation/execution.
boolean	isToolValid() Returns whether or not the current tool associated with the process is valid.
boolean	isValid() Indicates if the model element is valid.
void	load(IStream pstm) load
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	onToolAdded(IGPToolboxEventsOnToolAddedEvent theEvent) Called when a tool is added to the toolbox.
void	onToolboxDeleted(IGPToolboxEventsOnToolboxDeletedEvent theEvent) Called when the toolbox is deleted.
void	onToolboxRenamed(IGPToolboxEventsOnToolboxRenamedEvent theEvent) Called when the toolbox is renamed.
void	onToolDeleted(IGPToolboxEventsOnToolDeletedEvent theEvent) Called when a tool is deleted from the toolbox.
void	onToolStateChanged(IGPToolboxEventsOnToolStateChangedEvent theEvent) Called when a tool's state has changed.
void	onToolStored(IGPToolboxEventsOnToolStoredEvent theEvent) Called when a tool is stored to the toolbox.
void	readExternal(ObjectInput in)
void	repairParameters() Updates/repairs the processes collection of parameters to match the tool currently associated with the process.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAltered(boolean altered) Indicates if the model element has been altered by the user.
void	setCurrent(boolean current) Indicates if the model element is current (i.e., has been created).
void	setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr) The set of overriding environment values used when validating/executing the process.
void	setID(int identifier) Unique identifier of the model element.
void	setMarked(boolean marked) Indicates if the model element has been marked for validation/execution.
void	setModelByRef(IMdModel model) The model the model element is contained within.
void	setName(String name) Name of the model element.
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.
void	setValid(boolean valid) Indicates if the model element is valid.
IGPMessages	validate(boolean updateValues, IGPEnvironmentManager pEnvMgr) Validates the model element.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

MdProcess

public MdProcess()
          throws IOException,
                 UnknownHostException

Constructs a MdProcess using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MdProcess

public MdProcess(Object obj)
          throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MdProcess theMdProcess = (MdProcess) obj;

Construct a MdProcess using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MdProcess.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws IOException,
                 AutomationException

Unique identifier of the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:

getID in interface IMdElement

Returns:

The identifier

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int identifier)
           throws IOException,
                  AutomationException

Unique identifier of the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:

setID in interface IMdElement

Parameters:

identifier - The identifier (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:

getName in interface IMdElement

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Name of the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:

setName in interface IMdElement

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMarked

public boolean isMarked()
                 throws IOException,
                        AutomationException

Indicates if the model element has been marked for validation/execution.

Product Availability

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

Supported Platforms

Windows

Specified by:

isMarked in interface IMdElement

Returns:

The marked

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMarked

public void setMarked(boolean marked)
               throws IOException,
                      AutomationException

Indicates if the model element has been marked for validation/execution.

Product Availability

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

Supported Platforms

Windows

Specified by:

setMarked in interface IMdElement

Parameters:

marked - The marked (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCurrent

public boolean isCurrent()
                  throws IOException,
                         AutomationException

Indicates if the model element is current (i.e., has been created).

Product Availability

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

Supported Platforms

Windows

Specified by:

isCurrent in interface IMdElement

Returns:

The current

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrent

public void setCurrent(boolean current)
                throws IOException,
                       AutomationException

Indicates if the model element is current (i.e., has been created).

Product Availability

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

Supported Platforms

Windows

Specified by:

setCurrent in interface IMdElement

Parameters:

current - The current (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the model element is valid.

Product Availability

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

Supported Platforms

Windows

Specified by:

isValid in interface IMdElement

Returns:

The valid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValid

public void setValid(boolean valid)
              throws IOException,
                     AutomationException

Indicates if the model element is valid.

Product Availability

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

Supported Platforms

Windows

Specified by:

setValid in interface IMdElement

Parameters:

valid - The valid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModel

public IMdModel getModel()
                  throws IOException,
                         AutomationException

The model the model element is contained within.

Product Availability

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

Supported Platforms

Windows

Specified by:

getModel in interface IMdElement

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 the model element is contained within.

Product Availability

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

Specified by:

setModelByRef in interface IMdElement

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.

getState

public int getState()
             throws IOException,
                    AutomationException

The state of the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:

getState in interface IMdElement

Returns:

A com.esri.arcgis.geoprocessing.esriMdElementState constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDependents

public IEnumMdElement getDependents(int direction,
                                    int connectionType)
                             throws IOException,
                                    AutomationException

Returns an enumeration of model elements that are dependent on the model element in the given direction and of the given connection type.

Product Availability

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

Supported Platforms

Windows

Specified by:

getDependents in interface IMdElement

Parameters:

direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)

connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDependentOn

public boolean isDependentOn(IMdElement pMdElement,
                             int direction,
                             int connectionType)
                      throws IOException,
                             AutomationException

Returns whether or not the model element is dependent on the given model element in the given direction of the given connection type.

Product Availability

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

Supported Platforms

Windows

Specified by:

isDependentOn in interface IMdElement

Parameters:

pMdElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)

direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)

connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)

Returns:

The pDependentOn

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validate

public IGPMessages validate(boolean updateValues,
                            IGPEnvironmentManager pEnvMgr)
                     throws IOException,
                            AutomationException

Validates the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:

validate in interface IMdElement

Parameters:

updateValues - The updateValues (in)

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessages

public IGPMessages getMessages()
                        throws IOException,
                               AutomationException

Returns the messages returned from the last call to Validate().

Product Availability

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

Supported Platforms

Windows

Specified by:

getMessages in interface IMdElement

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAltered

public boolean isAltered()
                  throws IOException,
                         AutomationException

Indicates if the model element has been altered by the user.

Product Availability

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

Supported Platforms

Windows

Specified by:

isAltered in interface IMdElement

Returns:

The altered

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAltered

public void setAltered(boolean altered)
                throws IOException,
                       AutomationException

Indicates if the model element has been altered by the user.

Product Availability

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

Supported Platforms

Windows

Specified by:

setAltered in interface IMdElement

Parameters:

altered - The altered (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolName

public 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

Specified by:

getToolName in interface IMdProcess

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

public 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

Specified by:

getTool in interface IMdProcess

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

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

Specified by:

setToolByRef in interface IMdProcess

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

public 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

Specified by:

getParameters in interface IMdProcess

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

public 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

Specified by:

getInputParameters in interface IMdProcess

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

public 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

Specified by:

getOutputParameters in interface IMdProcess

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

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

Specified by:

getParameter in interface IMdProcess

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

public 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

Specified by:

getEnvironmentManager in interface IMdProcess

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

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

Specified by:

setEnvironmentManagerByRef in interface IMdProcess

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

public 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

Specified by:

setParameterValue in interface IMdProcess

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

public 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

Specified by:

getParameterValue in interface IMdProcess

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

public 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

Specified by:

execute in interface IMdProcess

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

public 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

Specified by:

isToolValid in interface IMdProcess

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

needsRepair

public 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

Specified by:

needsRepair in interface IMdProcess

Returns:

The needsRepair

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

repairParameters

public 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

Specified by:

repairParameters in interface IMdProcess

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreconditions

public 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

Specified by:

getPreconditions in interface IMdProcess

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

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

Specified by:

setPreconditionsByRef in interface IMdProcess

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.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolboxDeleted

public void onToolboxDeleted(IGPToolboxEventsOnToolboxDeletedEvent theEvent)
                      throws IOException,
                             AutomationException

Called when the toolbox is deleted.

Product Availability

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

Supported Platforms

Windows

Specified by:

onToolboxDeleted in interface IGPToolboxEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolboxRenamed

public void onToolboxRenamed(IGPToolboxEventsOnToolboxRenamedEvent theEvent)
                      throws IOException,
                             AutomationException

Called when the toolbox is renamed.

Product Availability

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

Supported Platforms

Windows

Specified by:

onToolboxRenamed in interface IGPToolboxEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolAdded

public void onToolAdded(IGPToolboxEventsOnToolAddedEvent theEvent)
                 throws IOException,
                        AutomationException

Called when a tool is added to the toolbox.

Product Availability

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

Supported Platforms

Windows

Specified by:

onToolAdded in interface IGPToolboxEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolDeleted

public void onToolDeleted(IGPToolboxEventsOnToolDeletedEvent theEvent)
                   throws IOException,
                          AutomationException

Called when a tool is deleted from the toolbox.

Product Availability

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

Supported Platforms

Windows

Specified by:

onToolDeleted in interface IGPToolboxEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolStored

public void onToolStored(IGPToolboxEventsOnToolStoredEvent theEvent)
                  throws IOException,
                         AutomationException

Called when a tool is stored to the toolbox.

Product Availability

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

Supported Platforms

Windows

Specified by:

onToolStored in interface IGPToolboxEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolStateChanged

public void onToolStateChanged(IGPToolboxEventsOnToolStateChangedEvent theEvent)
                        throws IOException,
                               AutomationException

Called when a tool's state has changed.

Product Availability

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

Supported Platforms

Windows

Specified by:

onToolStateChanged in interface IGPToolboxEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException