com.esri.arcgis.geoprocessing
Interface IGeoProcessor

All Superinterfaces:
Serializable
All Known Implementing Classes:
GeoProcessor

public interface IGeoProcessor
extends Serializable

The Geoprocessor. Provides access to toolboxes and tools.

When To Use

The IGeoprocessor contains properties and methods to execute tools, set global environment settings, add and remove toolboxes, and examine messages.

Refer to samples for executing geoprocressing tools.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void addError(String message)
          Output an error message.
 void addMessage(String message)
          Output an informative message.
 void addReturnMessage(int index)
          Output message from the last tool executed.
 void addToolbox(String toolbox)
          Add a toolbox to the current Geoprocessing session by catalog path.
 void addWarning(String message)
          Output a warning message.
 void clearMessages()
          Clear the messages to be returned as tool message when running within a script tool.
 IGeoProcessorResult createResult(String toolName, String jobID)
          Create a new result object.
 IGeoProcessorResult execute(String name, IVariantArray ipValues, ITrackCancel pTrackCancel)
          Execute a tool within the current Geoprocessing session.
 boolean exists(Object inputValue, Object pDataType)
          Test the existence of a given parameter value (GPValue or catalog path) the type of the data is optional.
 IDataElement getDataElement(Object inputValue, Object pDataType)
          Make a dataelement from the given value.
 Object getEnvironmentValue(String environmentName)
          Retrieve the value of an environment by name.
 int getMaxSeverity()
          Return the maximum severity of the message of the last tool executed.
 String getMessage(int index)
          Return the message description by index of the last tool executed.
 int getMessageCount()
          Return the number of messages of the last tool executed.
 String getMessages(Object pSeverity)
          Return all of the message descriptions of the last tool executed.
 int getParameterCount()
          Return the number of input command line or script tool parameters.
 Object getParameterValue(int index)
          Return the input command line or script tool parameter by index as a GPValue.
 int getReturnCode(int index)
          Return the message error code (Error Messages Only) by index of the last tool executed.
 IGPMessages getReturnMessages()
          Return the GPMessages object which will be messages of the last tool executed.
 int getSeverity(int index)
          Return the message severity by index of the last tool executed.
 boolean isAddOutputsToMap()
          Set whether resulting output datasets should be added to the application display.
 boolean isLogHistory()
          Set whether or not to log the execution of geoprocessing tools.
 boolean isOverwriteOutput()
          Set the overwrite outputs flag within the current Geoprocessing session.
 boolean isSynchronous(String toolName)
          Is server tool synchronous.
 boolean isTemporaryMapLayers()
          Set whether new map layers are temporary by default.
 IGpEnumList listDatasets(String wildCard, String datasetType)
          Return the list of feature datasets within the current workspace.
 IGpEnumList listEnvironments(String wildCard)
          Return the list of environments (properties) within the current Geoprocessing session.
 IGpEnumList listFeatureClasses(String wildCard, String featureType, String dataset)
          Return the list of feature classes within the current workspace or feature dataset within the workspace.
 IGpEnumList listRasters(String wildCard, String rasterType)
          Return the list of rasters within the current workspace.
 IGpEnumList listTables(String wildCard, String tableType)
          Return the list of tables within the current workspace.
 IGpEnumList listToolboxes(String wildCard)
          Return the list of toolboxes within the current Geoprocessing session.
 IGpEnumList listTools(String wildCard)
          Return the list of tools within the current Geoprocessing session.
 IGpEnumList listWorkspaces(String wildCard, String workspaceType)
          Return the list of workspaces within the current workspace (the workspace can be a folder).
 void loadSettings(String fileName)
          Load the current settings (toolboxes, environment values, etc) from a file on disk in XML format.
 Object open(Object value)
          Open an objector a namestring.
 String parseFieldName(String inputFieldName, String workspace)
          Parse a field name within the given workspace.
 String parseTableName(String inputTableName, String workspace)
          Parse a table name within the given workspace.
 String qualifyFieldName(String inputFieldName, String workspace)
          Qualify a field name within the given workspace.
 String qualifyTableName(String inputTableName, String workspace)
          Qualify a table name within the given workspace.
 void registerGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents)
          Register an object to recieve IGeoProcessorEvents.
 void removeToolbox(String toolbox)
          Remove a toolbox from the current Geoprocessing session by catalog path.
 void resetEnvironments()
          Reset the environments to their initial state.
 void saveSettings(String fileName)
          Save the current settings (toolboxes, environment values, etc) to a file on disk in XML format.
 void setAddOutputsToMap(boolean addToMap)
          Set whether resulting output datasets should be added to the application display.
 void setEnvironmentValue(String environmentName, Object value)
          Update the value of an environment by name.
 void setLogHistory(boolean logHistory)
          Set whether or not to log the execution of geoprocessing tools.
 void setOverwriteOutput(boolean pOverrideOutput)
          Set the overwrite outputs flag within the current Geoprocessing session.
 void setParameterValue(int index, Object value)
          Set the output script tool parameter by index as a GPValue.
 void setTemporaryMapLayers(boolean temporaryMapLayers)
          Set whether new map layers are temporary by default.
 String testSchemaLock(String fileName)
          Test for the presence of a schema lock (already open for writing) of a given file or dataset.
 void unRegisterGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents)
          UnRegister an object to stop recieving IGeoProcessorEvents.
 String usage(String method)
          Returns the command line usage of a given tool by name.
 IGPMessages validate(String name, IVariantArray ipValues, boolean bUpdateValues)
          Validate the parameters (input) of a tool within the current Geoprocessing session.
 String validateFieldName(String inputFieldName, String workspace)
          Validate a field name within the given workspace.
 String validateTableName(String inputTableName, String workspace)
          Validate a table or feature class name within the given workspace.
 

Method Detail

getEnvironmentValue

Object getEnvironmentValue(String environmentName)
                           throws IOException,
                                  AutomationException
Retrieve the value of an environment by name. The properties of the current Geoprocessing session.

Product Availability

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

Parameters:
environmentName - The environmentName (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnvironmentValue

void setEnvironmentValue(String environmentName,
                         Object value)
                         throws IOException,
                                AutomationException
Update the value of an environment by name. The properties of the current Geoprocessing session.

Product Availability

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

Parameters:
environmentName - The environmentName (in)
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetEnvironments

void resetEnvironments()
                       throws IOException,
                              AutomationException
Reset the environments to their initial state.

Product Availability

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

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

execute

IGeoProcessorResult execute(String name,
                            IVariantArray ipValues,
                            ITrackCancel pTrackCancel)
                            throws IOException,
                                   AutomationException
Execute a tool within the current Geoprocessing session.

Product Availability

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

Parameters:
name - The name (in)
ipValues - A reference to a com.esri.arcgis.system.IVariantArray (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validate

IGPMessages validate(String name,
                     IVariantArray ipValues,
                     boolean bUpdateValues)
                     throws IOException,
                            AutomationException
Validate the parameters (input) of a tool within the current Geoprocessing session.

Product Availability

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

Parameters:
name - The name (in)
ipValues - A reference to a com.esri.arcgis.system.IVariantArray (in)
bUpdateValues - The bUpdateValues (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.

open

Object open(Object value)
            throws IOException,
                   AutomationException
Open an objector a namestring. Example a DEFeatureClass object will return an IFeatureClass.

Product Availability

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

Parameters:
value - A Variant (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataElement

IDataElement getDataElement(Object inputValue,
                            Object pDataType)
                            throws IOException,
                                   AutomationException
Make a dataelement from the given value.

Product Availability

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

Parameters:
inputValue - A Variant (in)
pDataType - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listTools

IGpEnumList listTools(String wildCard)
                      throws IOException,
                             AutomationException
Return the list of tools within the current Geoprocessing session.

Product Availability

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

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

listEnvironments

IGpEnumList listEnvironments(String wildCard)
                             throws IOException,
                                    AutomationException
Return the list of environments (properties) within the current Geoprocessing session.

Product Availability

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

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

listToolboxes

IGpEnumList listToolboxes(String wildCard)
                          throws IOException,
                                 AutomationException
Return the list of toolboxes within the current Geoprocessing session.

Product Availability

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

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

addToolbox

void addToolbox(String toolbox)
                throws IOException,
                       AutomationException
Add a toolbox to the current Geoprocessing session by catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:
toolbox - The toolbox (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeToolbox

void removeToolbox(String toolbox)
                   throws IOException,
                          AutomationException
Remove a toolbox from the current Geoprocessing session by catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:
toolbox - The toolbox (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddOutputsToMap

void setAddOutputsToMap(boolean addToMap)
                        throws IOException,
                               AutomationException
Set whether resulting output datasets should be added to the application display.

Product Availability

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

Parameters:
addToMap - The addToMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAddOutputsToMap

boolean isAddOutputsToMap()
                          throws IOException,
                                 AutomationException
Set whether resulting output datasets should be added to the application display.

Product Availability

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

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

setOverwriteOutput

void setOverwriteOutput(boolean pOverrideOutput)
                        throws IOException,
                               AutomationException
Set the overwrite outputs flag within the current Geoprocessing session. True means outputs of tools will be overwritten.

Product Availability

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

Parameters:
pOverrideOutput - The pOverrideOutput (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverwriteOutput

boolean isOverwriteOutput()
                          throws IOException,
                                 AutomationException
Set the overwrite outputs flag within the current Geoprocessing session. True means outputs of tools will be overwritten.

Product Availability

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

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

setTemporaryMapLayers

void setTemporaryMapLayers(boolean temporaryMapLayers)
                           throws IOException,
                                  AutomationException
Set whether new map layers are temporary by default.

Product Availability

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

Parameters:
temporaryMapLayers - The temporaryMapLayers (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTemporaryMapLayers

boolean isTemporaryMapLayers()
                             throws IOException,
                                    AutomationException
Set whether new map layers are temporary by default.

Product Availability

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

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

setLogHistory

void setLogHistory(boolean logHistory)
                   throws IOException,
                          AutomationException
Set whether or not to log the execution of geoprocessing tools.

Product Availability

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

Parameters:
logHistory - The logHistory (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLogHistory

boolean isLogHistory()
                     throws IOException,
                            AutomationException
Set whether or not to log the execution of geoprocessing tools.

Product Availability

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

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

getReturnMessages

IGPMessages getReturnMessages()
                              throws IOException,
                                     AutomationException
Return the GPMessages object which will be messages of the last tool executed.

Product Availability

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

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.

getMessageCount

int getMessageCount()
                    throws IOException,
                           AutomationException
Return the number of messages of the last tool executed.

Product Availability

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

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

getMessage

String getMessage(int index)
                  throws IOException,
                         AutomationException
Return the message description by index of the last tool executed.

Product Availability

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

Parameters:
index - The index (in)
Returns:
The pMessage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSeverity

int getSeverity(int index)
                throws IOException,
                       AutomationException
Return the message severity by index of the last tool executed.

Product Availability

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

Parameters:
index - The index (in)
Returns:
The pSeverity
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReturnCode

int getReturnCode(int index)
                  throws IOException,
                         AutomationException
Return the message error code (Error Messages Only) by index of the last tool executed.

Product Availability

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

Parameters:
index - The index (in)
Returns:
The pCode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessages

String getMessages(Object pSeverity)
                   throws IOException,
                          AutomationException
Return all of the message descriptions of the last tool executed.

Product Availability

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

Parameters:
pSeverity - A Variant (in)
Returns:
The pMessages
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxSeverity

int getMaxSeverity()
                   throws IOException,
                          AutomationException
Return the maximum severity of the message of the last tool executed.

Product Availability

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

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

addMessage

void addMessage(String message)
                throws IOException,
                       AutomationException
Output an informative message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console

Product Availability

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

Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addError

void addError(String message)
              throws IOException,
                     AutomationException
Output an error message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console

Product Availability

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

Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addWarning

void addWarning(String message)
                throws IOException,
                       AutomationException
Output a warning message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console

Product Availability

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

Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addReturnMessage

void addReturnMessage(int index)
                      throws IOException,
                             AutomationException
Output message from the last tool executed. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console

Product Availability

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

Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearMessages

void clearMessages()
                   throws IOException,
                          AutomationException
Clear the messages to be returned as tool message when running within a script tool.

Product Availability

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

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

getParameterCount

int getParameterCount()
                      throws IOException,
                             AutomationException
Return the number of input command line or script tool parameters.

Product Availability

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

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

getParameterValue

Object getParameterValue(int index)
                         throws IOException,
                                AutomationException
Return the input command line or script tool parameter by index as a GPValue.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParameterValue

void setParameterValue(int index,
                       Object value)
                       throws IOException,
                              AutomationException
Set the output script tool parameter by index as a GPValue.

Product Availability

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

Parameters:
index - The index (in)
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exists

boolean exists(Object inputValue,
               Object pDataType)
               throws IOException,
                      AutomationException
Test the existence of a given parameter value (GPValue or catalog path) the type of the data is optional.

Product Availability

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

Parameters:
inputValue - A Variant (in)
pDataType - A Variant (in)
Returns:
The exists
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

usage

String usage(String method)
             throws IOException,
                    AutomationException
Returns the command line usage of a given tool by name.

Product Availability

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

Supported Platforms

Windows

Parameters:
method - The method (in)
Returns:
The usage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listFeatureClasses

IGpEnumList listFeatureClasses(String wildCard,
                               String featureType,
                               String dataset)
                               throws IOException,
                                      AutomationException
Return the list of feature classes within the current workspace or feature dataset within the workspace.

Product Availability

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

Parameters:
wildCard - The wildCard (in)
featureType - The featureType (in)
dataset - The dataset (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGpEnumList
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listDatasets

IGpEnumList listDatasets(String wildCard,
                         String datasetType)
                         throws IOException,
                                AutomationException
Return the list of feature datasets within the current workspace.

Product Availability

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

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

listWorkspaces

IGpEnumList listWorkspaces(String wildCard,
                           String workspaceType)
                           throws IOException,
                                  AutomationException
Return the list of workspaces within the current workspace (the workspace can be a folder).

Product Availability

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

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

listTables

IGpEnumList listTables(String wildCard,
                       String tableType)
                       throws IOException,
                              AutomationException
Return the list of tables within the current workspace.

Product Availability

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

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

listRasters

IGpEnumList listRasters(String wildCard,
                        String rasterType)
                        throws IOException,
                               AutomationException
Return the list of rasters within the current workspace.

Product Availability

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

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

validateFieldName

String validateFieldName(String inputFieldName,
                         String workspace)
                         throws IOException,
                                AutomationException
Validate a field name within the given workspace.

Product Availability

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

Parameters:
inputFieldName - The inputFieldName (in)
workspace - The workspace (in)
Returns:
The outputFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validateTableName

String validateTableName(String inputTableName,
                         String workspace)
                         throws IOException,
                                AutomationException
Validate a table or feature class name within the given workspace.

Product Availability

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

Parameters:
inputTableName - The inputTableName (in)
workspace - The workspace (in)
Returns:
The outputTableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

qualifyFieldName

String qualifyFieldName(String inputFieldName,
                        String workspace)
                        throws IOException,
                               AutomationException
Qualify a field name within the given workspace. This will add the connected user and database names.

Product Availability

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

Parameters:
inputFieldName - The inputFieldName (in)
workspace - The workspace (in)
Returns:
The outputFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

qualifyTableName

String qualifyTableName(String inputTableName,
                        String workspace)
                        throws IOException,
                               AutomationException
Qualify a table name within the given workspace. This will add the connected user and database names.

Product Availability

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

Parameters:
inputTableName - The inputTableName (in)
workspace - The workspace (in)
Returns:
The outputTableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

parseFieldName

String parseFieldName(String inputFieldName,
                      String workspace)
                      throws IOException,
                             AutomationException
Parse a field name within the given workspace. This will strip the connected user and database names.

Product Availability

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

Parameters:
inputFieldName - The inputFieldName (in)
workspace - The workspace (in)
Returns:
The outputParsedName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

parseTableName

String parseTableName(String inputTableName,
                      String workspace)
                      throws IOException,
                             AutomationException
Parse a table name within the given workspace. This will strip the connected user and database names.

Product Availability

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

Parameters:
inputTableName - The inputTableName (in)
workspace - The workspace (in)
Returns:
The outputParsedName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveSettings

void saveSettings(String fileName)
                  throws IOException,
                         AutomationException
Save the current settings (toolboxes, environment values, etc) to a file on disk in XML format.

Product Availability

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

Parameters:
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadSettings

void loadSettings(String fileName)
                  throws IOException,
                         AutomationException
Load the current settings (toolboxes, environment values, etc) from a file on disk in XML format.

Product Availability

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

Parameters:
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

testSchemaLock

String testSchemaLock(String fileName)
                      throws IOException,
                             AutomationException
Test for the presence of a schema lock (already open for writing) of a given file or dataset.

Product Availability

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

Parameters:
fileName - The fileName (in)
Returns:
The pStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerGeoProcessorEvents

void registerGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents)
                                throws IOException,
                                       AutomationException
Register an object to recieve IGeoProcessorEvents.

Product Availability

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

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

unRegisterGeoProcessorEvents

void unRegisterGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents)
                                  throws IOException,
                                         AutomationException
UnRegister an object to stop recieving IGeoProcessorEvents.

Product Availability

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

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

createResult

IGeoProcessorResult createResult(String toolName,
                                 String jobID)
                                 throws IOException,
                                        AutomationException
Create a new result object.

Product Availability

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

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

isSynchronous

boolean isSynchronous(String toolName)
                      throws IOException,
                             AutomationException
Is server tool synchronous.

Product Availability

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

Parameters:
toolName - The toolName (in)
Returns:
The isSynchronous
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.