com.esri.arcgis.geoprocessing
Interface IGpDispatch

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IGpDispatchProxy

public interface IGpDispatch
extends java.io.Serializable

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

Description: 'Provides access to the properties and methods of a Geoprocessor object.' 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	DISPID_1_GET_NAME
static java.lang.String	DISPID_100_GET_NAME
static java.lang.String	DISPID_101_NAME
static java.lang.String	DISPID_102_NAME
static java.lang.String	DISPID_105_NAME
static java.lang.String	DISPID_11_NAME
static java.lang.String	DISPID_110_NAME
static java.lang.String	DISPID_111_NAME
static java.lang.String	DISPID_112_NAME
static java.lang.String	DISPID_113_GET_NAME
static java.lang.String	DISPID_113_PUT_NAME
static java.lang.String	DISPID_114_NAME
static java.lang.String	DISPID_115_NAME
static java.lang.String	DISPID_116_NAME
static java.lang.String	DISPID_12_NAME
static java.lang.String	DISPID_13_NAME
static java.lang.String	DISPID_130_NAME
static java.lang.String	DISPID_131_NAME
static java.lang.String	DISPID_132_NAME
static java.lang.String	DISPID_14_NAME
static java.lang.String	DISPID_141_NAME
static java.lang.String	DISPID_150_NAME
static java.lang.String	DISPID_151_NAME
static java.lang.String	DISPID_152_NAME
static java.lang.String	DISPID_153_NAME
static java.lang.String	DISPID_154_NAME
static java.lang.String	DISPID_158_NAME
static java.lang.String	DISPID_159_NAME
static java.lang.String	DISPID_170_NAME
static java.lang.String	DISPID_171_NAME
static java.lang.String	DISPID_172_NAME
static java.lang.String	DISPID_173_NAME
static java.lang.String	DISPID_180_NAME
static java.lang.String	DISPID_181_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_202_GET_NAME
static java.lang.String	DISPID_202_PUT_NAME
static java.lang.String	DISPID_203_GET_NAME
static java.lang.String	DISPID_203_PUT_NAME
static java.lang.String	DISPID_210_NAME
static java.lang.String	DISPID_211_NAME
static java.lang.String	DISPID_212_NAME
static java.lang.String	DISPID_213_NAME
static java.lang.String	DISPID_214_NAME
static java.lang.String	DISPID_215_NAME
static java.lang.String	DISPID_216_NAME
static java.lang.String	DISPID_217_NAME
static java.lang.String	DISPID_218_NAME
static java.lang.String	DISPID_219_NAME
static java.lang.String	DISPID_220_NAME
static java.lang.String	DISPID_230_NAME
static java.lang.String	DISPID_240_NAME
static java.lang.String	DISPID_3_NAME
static java.lang.String	DISPID_4_NAME
static java.lang.String	DISPID_5_NAME
static java.lang.String	DISPID_50_NAME
static java.lang.String	DISPID_51_NAME
static java.lang.String	DISPID_52_NAME
static java.lang.String	DISPID_53_NAME
static java.lang.String	DISPID_54_NAME
static java.lang.String	DISPID_55_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IIDccbc8b04_f507_423d_a9b8_20971e86ea86
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addError(java.lang.String message) Sets the output error message.
void	addMessage(java.lang.String message) Sets the output message.
void	addReturnMessage(int index) Sets the return message as an output message by index.
void	addToolbox(java.lang.String toolbox) Add the toolbox to the current session.
void	addWarning(java.lang.String message) Sets the output warning message.
java.lang.String	checkExtension(java.lang.String extension) Checks the status of a product extension.
java.lang.String	checkInExtension(java.lang.String extension) Checks in a product extension.
java.lang.String	checkOutExtension(java.lang.String extension) Checks out a product extension.
java.lang.String	checkProduct(java.lang.String code) Check the status of a license code.
void	clearEnvironment(java.lang.String env) Clears the value of a given environment.
java.lang.String	command(java.lang.String commandLine) executes the given command line.
void	copyParameter(int from, int to) Copy given tool parameter to another.
java.lang.Object	createObject(java.lang.Object pObjectName, java.lang.Object pExtraArg) Creates a geoprocessing object that can be used in a scripting environment.
java.lang.Object	createRandomValueGenerator(int seed, java.lang.String distributionType) Creates a geoprocessing random number generator object that can be used to generate random numbers.
java.lang.String	createScratchName(java.lang.Object prefix, java.lang.Object suffix, java.lang.Object dataType, java.lang.Object workspace) Creates a scratch name for the given workspace.
java.lang.String	createUniqueName(java.lang.String inputTableName, java.lang.Object workspace) Creates a unique name for the given workspace.
java.lang.Object	describe(java.lang.Object pInputValue, java.lang.Object dataType) Returns a descriptor object describing the properties of the specified data element.
boolean	exists(java.lang.Object pInputValue, java.lang.Object dataType) Checks if a data element exists.
int	getMaxSeverity() The maximum severity of the return messages.
java.lang.String	getMessage(int index) Gets the return message by index.
int	getMessageCount() The number of returned messages.
java.lang.String	getMessages(java.lang.Object severity) Gets all the return messages.
java.lang.String	getParameterAsText(int index) Gets given tool parameter as text.
int	getParameterCount() The number of input tool parameters.
int	getReturnCode(int index) Gets the return code by index.
int	getSeverity(int index) Gets the return severity by index.
java.lang.String	getSystemEnvironment(java.lang.String envName) Gets the given system environment.
java.lang.String	getToolbox() Sets the current (default) toolbox.
java.lang.Object	insertCursor(java.lang.Object pInputValue, java.lang.Object spRef) Returns an insert cursor object against the given table/feature class.
boolean	isLogHistory() Indicates whether or not operations are logged or not.
boolean	isOverwriteOutput() Indicates whether or not outputs should be overwritten.
java.lang.Object	listDatasets(java.lang.Object wildCard, java.lang.Object featureType) Returns a collection of datasets in the current workspace based on a query string and type.
java.lang.Object	listEnvironments(java.lang.Object pWildcard) Gets list of GeoProcessor Environments.
java.lang.Object	listFeatureClasses(java.lang.Object wildCard, java.lang.Object featureType, java.lang.Object dataset) Returns a collection of feature classes in the current workspace or optional dataset, based on a query string and type.
java.lang.Object	listFields(java.lang.Object pInputValue, java.lang.Object wildCard, java.lang.Object fieldType) Returns a collection of fields in the given table/feature class based on a query string and type.
java.lang.Object	listIndexes(java.lang.Object pInputValue, java.lang.Object wildCard) Returns a collection of indexes in the given table/feature class based on a query string and type.
java.lang.Object	listRasters(java.lang.Object wildCard, java.lang.Object rasterType) Returns a collection of rasters in the current workspace based on a query string and type.
java.lang.Object	listTables(java.lang.Object wildCard, java.lang.Object tableType) Returns a collection of tables in the current workspace based on a query string and type.
java.lang.Object	listToolboxes(java.lang.Object pWildcard) Gets list of GeoProcessor Toolboxes.
java.lang.Object	listTools(java.lang.Object pWildcard) Gets list of GeoProcessor Tools.
java.lang.Object	listWorkspaces(java.lang.Object wildCard, java.lang.Object workspaceType) Returns a collection of workspaces in the current workspace based on a query string and type.
void	loadSettings(java.lang.String fileName) Loads the current GeoProcessor environment settings.
java.lang.String	parseFieldName(java.lang.String inputFieldName, java.lang.Object workspace) Parses a field name into its constituent parts.
java.lang.String	parseTableName(java.lang.String inputTableName, java.lang.Object workspace) Parses a table name into its constituent parts.
java.lang.String	productInfo() Gets the product license info.
java.lang.String	qualifyFieldName(java.lang.String inputFieldName, java.lang.Object workspace) Qualifies a field name for the workspace and connected user.
java.lang.String	qualifyTableName(java.lang.String inputTableName, java.lang.Object workspace) Qualifies a table name for the workspace and connected user.
void	refreshCatalog(java.lang.Object pInputValue) Refreshes the parent of the specified object in the catalog object associated with the Geoprocessor.
void	removeToolbox(java.lang.String toolbox) Remove the toolbox from the current session.
void	resetEnvironments() Tests if a given environments value is set or not.
void	saveSettings(java.lang.String fileName) Saves the current GeoProcessor environment settings.
java.lang.Object	searchCursor(java.lang.Object pInputValue, java.lang.Object whereClause, java.lang.Object spRef, java.lang.Object fields, java.lang.Object sortFields) Returns a search cursor object against the given table/feature class.
void	setLogHistory(boolean logHistory) Indicates whether or not operations are logged or not.
void	setOverwriteOutput(boolean overwriteOutput) Indicates whether or not outputs should be overwritten.
void	setParameterAsText(int index, java.lang.String argument) Sets given tool parameter as text.
java.lang.String	setProduct(java.lang.String code) Sets the license level.
void	setToolbox(java.lang.String toolbox) Sets the current (default) toolbox.
java.lang.String	testSchemaLock(java.lang.String fileName) Tests if an exclusive schema lock is set on a dataset.
java.lang.Object	updateCursor(java.lang.Object pInputValue, java.lang.Object whereClause, java.lang.Object spRef, java.lang.Object fields, java.lang.Object sortFields) Returns an update cursor object against the given table/feature class.
java.lang.String	usage(java.lang.String method) Generates the Usage for a given tool.
java.lang.String	validateFieldName(java.lang.String inputFieldName, java.lang.Object workspace) Checks a field for compatibility with the workspace.
java.lang.String	validateTableName(java.lang.String inputTableName, java.lang.Object workspace) Checks a table name for compatibility with the workspace.

Field Detail

IIDccbc8b04_f507_423d_a9b8_20971e86ea86

static final int IIDccbc8b04_f507_423d_a9b8_20971e86ea86

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

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_NAME

See Also:

Constant Field Values

DISPID_3_NAME

static final java.lang.String DISPID_3_NAME

See Also:

Constant Field Values

DISPID_4_NAME

static final java.lang.String DISPID_4_NAME

See Also:

Constant Field Values

DISPID_5_NAME

static final java.lang.String DISPID_5_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_11_NAME

static final java.lang.String DISPID_11_NAME

See Also:

Constant Field Values

DISPID_12_NAME

static final java.lang.String DISPID_12_NAME

See Also:

Constant Field Values

DISPID_13_NAME

static final java.lang.String DISPID_13_NAME

See Also:

Constant Field Values

DISPID_14_NAME

static final java.lang.String DISPID_14_NAME

See Also:

Constant Field Values

DISPID_50_NAME

static final java.lang.String DISPID_50_NAME

See Also:

Constant Field Values

DISPID_51_NAME

static final java.lang.String DISPID_51_NAME

See Also:

Constant Field Values

DISPID_52_NAME

static final java.lang.String DISPID_52_NAME

See Also:

Constant Field Values

DISPID_53_NAME

static final java.lang.String DISPID_53_NAME

See Also:

Constant Field Values

DISPID_54_NAME

static final java.lang.String DISPID_54_NAME

See Also:

Constant Field Values

DISPID_55_NAME

static final java.lang.String DISPID_55_NAME

See Also:

Constant Field Values

DISPID_100_GET_NAME

static final java.lang.String DISPID_100_GET_NAME

See Also:

Constant Field Values

DISPID_101_NAME

static final java.lang.String DISPID_101_NAME

See Also:

Constant Field Values

DISPID_102_NAME

static final java.lang.String DISPID_102_NAME

See Also:

Constant Field Values

DISPID_105_NAME

static final java.lang.String DISPID_105_NAME

See Also:

Constant Field Values

DISPID_110_NAME

static final java.lang.String DISPID_110_NAME

See Also:

Constant Field Values

DISPID_111_NAME

static final java.lang.String DISPID_111_NAME

See Also:

Constant Field Values

DISPID_112_NAME

static final java.lang.String DISPID_112_NAME

See Also:

Constant Field Values

DISPID_113_PUT_NAME

static final java.lang.String DISPID_113_PUT_NAME

See Also:

Constant Field Values

DISPID_113_GET_NAME

static final java.lang.String DISPID_113_GET_NAME

See Also:

Constant Field Values

DISPID_114_NAME

static final java.lang.String DISPID_114_NAME

See Also:

Constant Field Values

DISPID_115_NAME

static final java.lang.String DISPID_115_NAME

See Also:

Constant Field Values

DISPID_116_NAME

static final java.lang.String DISPID_116_NAME

See Also:

Constant Field Values

DISPID_130_NAME

static final java.lang.String DISPID_130_NAME

See Also:

Constant Field Values

DISPID_131_NAME

static final java.lang.String DISPID_131_NAME

See Also:

Constant Field Values

DISPID_132_NAME

static final java.lang.String DISPID_132_NAME

See Also:

Constant Field Values

DISPID_141_NAME

static final java.lang.String DISPID_141_NAME

See Also:

Constant Field Values

DISPID_150_NAME

static final java.lang.String DISPID_150_NAME

See Also:

Constant Field Values

DISPID_151_NAME

static final java.lang.String DISPID_151_NAME

See Also:

Constant Field Values

DISPID_152_NAME

static final java.lang.String DISPID_152_NAME

See Also:

Constant Field Values

DISPID_153_NAME

static final java.lang.String DISPID_153_NAME

See Also:

Constant Field Values

DISPID_154_NAME

static final java.lang.String DISPID_154_NAME

See Also:

Constant Field Values

DISPID_158_NAME

static final java.lang.String DISPID_158_NAME

See Also:

Constant Field Values

DISPID_159_NAME

static final java.lang.String DISPID_159_NAME

See Also:

Constant Field Values

DISPID_170_NAME

static final java.lang.String DISPID_170_NAME

See Also:

Constant Field Values

DISPID_171_NAME

static final java.lang.String DISPID_171_NAME

See Also:

Constant Field Values

DISPID_172_NAME

static final java.lang.String DISPID_172_NAME

See Also:

Constant Field Values

DISPID_173_NAME

static final java.lang.String DISPID_173_NAME

See Also:

Constant Field Values

DISPID_180_NAME

static final java.lang.String DISPID_180_NAME

See Also:

Constant Field Values

DISPID_181_NAME

static final java.lang.String DISPID_181_NAME

See Also:

Constant Field Values

DISPID_202_PUT_NAME

static final java.lang.String DISPID_202_PUT_NAME

See Also:

Constant Field Values

DISPID_202_GET_NAME

static final java.lang.String DISPID_202_GET_NAME

See Also:

Constant Field Values

DISPID_203_PUT_NAME

static final java.lang.String DISPID_203_PUT_NAME

See Also:

Constant Field Values

DISPID_203_GET_NAME

static final java.lang.String DISPID_203_GET_NAME

See Also:

Constant Field Values

DISPID_210_NAME

static final java.lang.String DISPID_210_NAME

See Also:

Constant Field Values

DISPID_211_NAME

static final java.lang.String DISPID_211_NAME

See Also:

Constant Field Values

DISPID_212_NAME

static final java.lang.String DISPID_212_NAME

See Also:

Constant Field Values

DISPID_213_NAME

static final java.lang.String DISPID_213_NAME

See Also:

Constant Field Values

DISPID_214_NAME

static final java.lang.String DISPID_214_NAME

See Also:

Constant Field Values

DISPID_215_NAME

static final java.lang.String DISPID_215_NAME

See Also:

Constant Field Values

DISPID_216_NAME

static final java.lang.String DISPID_216_NAME

See Also:

Constant Field Values

DISPID_217_NAME

static final java.lang.String DISPID_217_NAME

See Also:

Constant Field Values

DISPID_218_NAME

static final java.lang.String DISPID_218_NAME

See Also:

Constant Field Values

DISPID_219_NAME

static final java.lang.String DISPID_219_NAME

See Also:

Constant Field Values

DISPID_220_NAME

static final java.lang.String DISPID_220_NAME

See Also:

Constant Field Values

DISPID_230_NAME

static final java.lang.String DISPID_230_NAME

See Also:

Constant Field Values

DISPID_240_NAME

static final java.lang.String DISPID_240_NAME

See Also:

Constant Field Values

Method Detail

getMessageCount

int getMessageCount()
                    throws java.io.IOException,
                           AutomationException

The number of returned messages.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

java.lang.String getMessage(int index)
                            throws java.io.IOException,
                                   AutomationException

Gets the return message by index.

Parameters:

index - The index (in)

Returns:

The message

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeverity

int getSeverity(int index)
                throws java.io.IOException,
                       AutomationException

Gets the return severity by index.

Parameters:

index - The index (in)

Returns:

The severity

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReturnCode

int getReturnCode(int index)
                  throws java.io.IOException,
                         AutomationException

Gets the return code by index.

Parameters:

index - The index (in)

Returns:

The code

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessages

java.lang.String getMessages(java.lang.Object severity)
                             throws java.io.IOException,
                                    AutomationException

Gets all the return messages.

Parameters:

severity - A Variant (in, optional, pass null if not required)

Returns:

The messages

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxSeverity

int getMaxSeverity()
                   throws java.io.IOException,
                          AutomationException

The maximum severity of the return messages.

Returns:

The severity

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMessage

void addMessage(java.lang.String message)
                throws java.io.IOException,
                       AutomationException

Sets the output message.

Parameters:

message - The message (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addError

void addError(java.lang.String message)
              throws java.io.IOException,
                     AutomationException

Sets the output error message.

Parameters:

message - The message (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addWarning

void addWarning(java.lang.String message)
                throws java.io.IOException,
                       AutomationException

Sets the output warning message.

Parameters:

message - The message (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addReturnMessage

void addReturnMessage(int index)
                      throws java.io.IOException,
                             AutomationException

Sets the return message as an output message by index.

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProduct

java.lang.String setProduct(java.lang.String code)
                            throws java.io.IOException,
                                   AutomationException

Sets the license level.

Parameters:

code - The code (in)

Returns:

The status

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkProduct

java.lang.String checkProduct(java.lang.String code)
                              throws java.io.IOException,
                                     AutomationException

Check the status of a license code.

Parameters:

code - The code (in)

Returns:

The status

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

productInfo

java.lang.String productInfo()
                             throws java.io.IOException,
                                    AutomationException

Gets the product license info.

Returns:

The status

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkOutExtension

java.lang.String checkOutExtension(java.lang.String extension)
                                   throws java.io.IOException,
                                          AutomationException

Checks out a product extension.

Parameters:

extension - The extension (in)

Returns:

The status

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkInExtension

java.lang.String checkInExtension(java.lang.String extension)
                                  throws java.io.IOException,
                                         AutomationException

Checks in a product extension.

Parameters:

extension - The extension (in)

Returns:

The status

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkExtension

java.lang.String checkExtension(java.lang.String extension)
                                throws java.io.IOException,
                                       AutomationException

Checks the status of a product extension.

Parameters:

extension - The extension (in)

Returns:

The status

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterCount

int getParameterCount()
                      throws java.io.IOException,
                             AutomationException

The number of input tool parameters.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterAsText

java.lang.String getParameterAsText(int index)
                                    throws java.io.IOException,
                                           AutomationException

Gets given tool parameter as text.

Parameters:

index - The index (in)

Returns:

The argument

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterAsText

void setParameterAsText(int index,
                        java.lang.String argument)
                        throws java.io.IOException,
                               AutomationException

Sets given tool parameter as text.

Parameters:

index - The index (in)

argument - The argument (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copyParameter

void copyParameter(int from,
                   int to)
                   throws java.io.IOException,
                          AutomationException

Copy given tool parameter to another.

Parameters:

from - The from (in)

to - The to (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listTools

java.lang.Object listTools(java.lang.Object pWildcard)
                           throws java.io.IOException,
                                  AutomationException

Gets list of GeoProcessor Tools.

Parameters:

pWildcard - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listEnvironments

java.lang.Object listEnvironments(java.lang.Object pWildcard)
                                  throws java.io.IOException,
                                         AutomationException

Gets list of GeoProcessor Environments.

Parameters:

pWildcard - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listToolboxes

java.lang.Object listToolboxes(java.lang.Object pWildcard)
                               throws java.io.IOException,
                                      AutomationException

Gets list of GeoProcessor Toolboxes.

Parameters:

pWildcard - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolbox

void setToolbox(java.lang.String toolbox)
                throws java.io.IOException,
                       AutomationException

Sets the current (default) toolbox.

Parameters:

toolbox - The toolbox (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolbox

java.lang.String getToolbox()
                            throws java.io.IOException,
                                   AutomationException

Sets the current (default) toolbox.

Returns:

The toolbox

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addToolbox

void addToolbox(java.lang.String toolbox)
                throws java.io.IOException,
                       AutomationException

Add the toolbox to the current session.

Parameters:

toolbox - The toolbox (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeToolbox

void removeToolbox(java.lang.String toolbox)
                   throws java.io.IOException,
                          AutomationException

Remove the toolbox from the current session.

Parameters:

toolbox - The toolbox (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSystemEnvironment

java.lang.String getSystemEnvironment(java.lang.String envName)
                                      throws java.io.IOException,
                                             AutomationException

Gets the given system environment.

Parameters:

envName - The envName (in)

Returns:

The pEnvironment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

command

java.lang.String command(java.lang.String commandLine)
                         throws java.io.IOException,
                                AutomationException

executes the given command line.

Parameters:

commandLine - The commandLine (in)

Returns:

The results

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

usage

java.lang.String usage(java.lang.String method)
                       throws java.io.IOException,
                              AutomationException

Generates the Usage for a given tool.

Parameters:

method - The method (in)

Returns:

The usage

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exists

boolean exists(java.lang.Object pInputValue,
               java.lang.Object dataType)
               throws java.io.IOException,
                      AutomationException

Checks if a data element exists.

Parameters:

pInputValue - A Variant (in)

dataType - A Variant (in, optional, pass null if not required)

Returns:

The exists

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshCatalog

void refreshCatalog(java.lang.Object pInputValue)
                    throws java.io.IOException,
                           AutomationException

Refreshes the parent of the specified object in the catalog object associated with the Geoprocessor.

Parameters:

pInputValue - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listFeatureClasses

java.lang.Object listFeatureClasses(java.lang.Object wildCard,
                                    java.lang.Object featureType,
                                    java.lang.Object dataset)
                                    throws java.io.IOException,
                                           AutomationException

Returns a collection of feature classes in the current workspace or optional dataset, based on a query string and type.

Parameters:

wildCard - A Variant (in, optional, pass null if not required)

featureType - A Variant (in, optional, pass null if not required)

dataset - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listDatasets

java.lang.Object listDatasets(java.lang.Object wildCard,
                              java.lang.Object featureType)
                              throws java.io.IOException,
                                     AutomationException

Returns a collection of datasets in the current workspace based on a query string and type.

Parameters:

wildCard - A Variant (in, optional, pass null if not required)

featureType - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listTables

java.lang.Object listTables(java.lang.Object wildCard,
                            java.lang.Object tableType)
                            throws java.io.IOException,
                                   AutomationException

Returns a collection of tables in the current workspace based on a query string and type.

Parameters:

wildCard - A Variant (in, optional, pass null if not required)

tableType - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listRasters

java.lang.Object listRasters(java.lang.Object wildCard,
                             java.lang.Object rasterType)
                             throws java.io.IOException,
                                    AutomationException

Returns a collection of rasters in the current workspace based on a query string and type.

Parameters:

wildCard - A Variant (in, optional, pass null if not required)

rasterType - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listWorkspaces

java.lang.Object listWorkspaces(java.lang.Object wildCard,
                                java.lang.Object workspaceType)
                                throws java.io.IOException,
                                       AutomationException

Returns a collection of workspaces in the current workspace based on a query string and type.

Parameters:

wildCard - A Variant (in, optional, pass null if not required)

workspaceType - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listFields

java.lang.Object listFields(java.lang.Object pInputValue,
                            java.lang.Object wildCard,
                            java.lang.Object fieldType)
                            throws java.io.IOException,
                                   AutomationException

Returns a collection of fields in the given table/feature class based on a query string and type.

Parameters:

pInputValue - A Variant (in)

wildCard - A Variant (in, optional, pass null if not required)

fieldType - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listIndexes

java.lang.Object listIndexes(java.lang.Object pInputValue,
                             java.lang.Object wildCard)
                             throws java.io.IOException,
                                    AutomationException

Returns a collection of indexes in the given table/feature class based on a query string and type.

Parameters:

pInputValue - A Variant (in)

wildCard - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchCursor

java.lang.Object searchCursor(java.lang.Object pInputValue,
                              java.lang.Object whereClause,
                              java.lang.Object spRef,
                              java.lang.Object fields,
                              java.lang.Object sortFields)
                              throws java.io.IOException,
                                     AutomationException

Returns a search cursor object against the given table/feature class.

Parameters:

pInputValue - A Variant (in)

whereClause - A Variant (in, optional, pass null if not required)

spRef - A Variant (in, optional, pass null if not required)

fields - A Variant (in, optional, pass null if not required)

sortFields - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateCursor

java.lang.Object updateCursor(java.lang.Object pInputValue,
                              java.lang.Object whereClause,
                              java.lang.Object spRef,
                              java.lang.Object fields,
                              java.lang.Object sortFields)
                              throws java.io.IOException,
                                     AutomationException

Returns an update cursor object against the given table/feature class.

Parameters:

pInputValue - A Variant (in)

whereClause - A Variant (in, optional, pass null if not required)

spRef - A Variant (in, optional, pass null if not required)

fields - A Variant (in, optional, pass null if not required)

sortFields - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertCursor

java.lang.Object insertCursor(java.lang.Object pInputValue,
                              java.lang.Object spRef)
                              throws java.io.IOException,
                                     AutomationException

Returns an insert cursor object against the given table/feature class.

Parameters:

pInputValue - A Variant (in)

spRef - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

describe

java.lang.Object describe(java.lang.Object pInputValue,
                          java.lang.Object dataType)
                          throws java.io.IOException,
                                 AutomationException

Returns a descriptor object describing the properties of the specified data element.

Parameters:

pInputValue - A Variant (in)

dataType - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createObject

java.lang.Object createObject(java.lang.Object pObjectName,
                              java.lang.Object pExtraArg)
                              throws java.io.IOException,
                                     AutomationException

Creates a geoprocessing object that can be used in a scripting environment.

Parameters:

pObjectName - A Variant (in)

pExtraArg - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRandomValueGenerator

java.lang.Object createRandomValueGenerator(int seed,
                                            java.lang.String distributionType)
                                            throws java.io.IOException,
                                                   AutomationException

Creates a geoprocessing random number generator object that can be used to generate random numbers.

Parameters:

seed - The seed (in)

distributionType - The distributionType (in)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverwriteOutput

void setOverwriteOutput(boolean overwriteOutput)
                        throws java.io.IOException,
                               AutomationException

Indicates whether or not outputs should be overwritten.

Parameters:

overwriteOutput - The overwriteOutput (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOverwriteOutput

boolean isOverwriteOutput()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether or not outputs should be overwritten.

Returns:

The overwriteOutput

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogHistory

void setLogHistory(boolean logHistory)
                   throws java.io.IOException,
                          AutomationException

Indicates whether or not operations are logged or not.

Parameters:

logHistory - The logHistory (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLogHistory

boolean isLogHistory()
                     throws java.io.IOException,
                            AutomationException

Indicates whether or not operations are logged or not.

Returns:

The logHistory

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validateFieldName

java.lang.String validateFieldName(java.lang.String inputFieldName,
                                   java.lang.Object workspace)
                                   throws java.io.IOException,
                                          AutomationException

Checks a field for compatibility with the workspace.

Parameters:

inputFieldName - The inputFieldName (in)

workspace - A Variant (in, optional, pass null if not required)

Returns:

The outputFieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validateTableName

java.lang.String validateTableName(java.lang.String inputTableName,
                                   java.lang.Object workspace)
                                   throws java.io.IOException,
                                          AutomationException

Checks a table name for compatibility with the workspace.

Parameters:

inputTableName - The inputTableName (in)

workspace - A Variant (in, optional, pass null if not required)

Returns:

The outputTableName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

qualifyFieldName

java.lang.String qualifyFieldName(java.lang.String inputFieldName,
                                  java.lang.Object workspace)
                                  throws java.io.IOException,
                                         AutomationException

Qualifies a field name for the workspace and connected user.

Parameters:

inputFieldName - The inputFieldName (in)

workspace - A Variant (in, optional, pass null if not required)

Returns:

The outputFieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

qualifyTableName

java.lang.String qualifyTableName(java.lang.String inputTableName,
                                  java.lang.Object workspace)
                                  throws java.io.IOException,
                                         AutomationException

Qualifies a table name for the workspace and connected user.

Parameters:

inputTableName - The inputTableName (in)

workspace - A Variant (in, optional, pass null if not required)

Returns:

The outputTableName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

parseFieldName

java.lang.String parseFieldName(java.lang.String inputFieldName,
                                java.lang.Object workspace)
                                throws java.io.IOException,
                                       AutomationException

Parses a field name into its constituent parts.

Parameters:

inputFieldName - The inputFieldName (in)

workspace - A Variant (in, optional, pass null if not required)

Returns:

The outputParsedName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

parseTableName

java.lang.String parseTableName(java.lang.String inputTableName,
                                java.lang.Object workspace)
                                throws java.io.IOException,
                                       AutomationException

Parses a table name into its constituent parts.

Parameters:

inputTableName - The inputTableName (in)

workspace - A Variant (in, optional, pass null if not required)

Returns:

The outputParsedName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createScratchName

java.lang.String createScratchName(java.lang.Object prefix,
                                   java.lang.Object suffix,
                                   java.lang.Object dataType,
                                   java.lang.Object workspace)
                                   throws java.io.IOException,
                                          AutomationException

Creates a scratch name for the given workspace.

Parameters:

prefix - A Variant (in, optional, pass null if not required)

suffix - A Variant (in, optional, pass null if not required)

dataType - A Variant (in, optional, pass null if not required)

workspace - A Variant (in, optional, pass null if not required)

Returns:

The outputTableName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createUniqueName

java.lang.String createUniqueName(java.lang.String inputTableName,
                                  java.lang.Object workspace)
                                  throws java.io.IOException,
                                         AutomationException

Creates a unique name for the given workspace.

Parameters:

inputTableName - The inputTableName (in)

workspace - A Variant (in, optional, pass null if not required)

Returns:

The outputTableName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveSettings

void saveSettings(java.lang.String fileName)
                  throws java.io.IOException,
                         AutomationException

Saves the current GeoProcessor environment settings.

Parameters:

fileName - The fileName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadSettings

void loadSettings(java.lang.String fileName)
                  throws java.io.IOException,
                         AutomationException

Loads the current GeoProcessor environment settings.

Parameters:

fileName - The fileName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

testSchemaLock

java.lang.String testSchemaLock(java.lang.String fileName)
                                throws java.io.IOException,
                                       AutomationException

Tests if an exclusive schema lock is set on a dataset.

Parameters:

fileName - The fileName (in)

Returns:

The status

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearEnvironment

void clearEnvironment(java.lang.String env)
                      throws java.io.IOException,
                             AutomationException

Clears the value of a given environment.

Parameters:

env - The env (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetEnvironments

void resetEnvironments()
                       throws java.io.IOException,
                              AutomationException

Tests if a given environments value is set or not.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.