com.esri.arcgis.geoprocessing
Interface IGPEnvironmentManager

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GPEnvironmentManager, IGPEnvironmentManagerProxy

public interface IGPEnvironmentManager
extends java.io.Serializable

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

Description: 'Provides access to the properties/methods of a geoprocessing environment management 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	IID Deprecated. Internal use only
static int	IID91c2edf4_6e2c_43f5_b526_e1a94f6615aa
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addEnvironment(IGPEnvironment env) Adds the given geoprocessing environment to the environment manager.
IGPEnvironment	findEnvironment(java.lang.String name) Locates and returns the environment with the specified name.
IArray	getEnvironments() Returns the environments of the environment manager as an array.
java.lang.Object	getEnvVariant(IGPEnvironment env) Returns the value of the given environment as a variant.
IArray	getLocalEnvironments() Returns an array of the environments that have been updated locally.
IGPEnvironmentManager	getParent() Returns the parent environment manager.
void	putEnvVariant(IGPEnvironment env, java.lang.Object value) Sets the value of the given environment to the given variant.
void	removeEnvironment(IGPEnvironment env) Removes the given geoprocessing environment from the environment manager.
void	removeEnvironments() Removes all environments from the environment manager.
void	setParentByRef(IGPEnvironmentManager parent) Returns the parent environment manager.
void	setPersistAll(boolean rhs1) Indicates whether all environments or only local environments are persisted.
void	substituteEnvironments(IArray pParams) Substitues the values of the given array of parameters with the current environment values.

Field Detail

IID91c2edf4_6e2c_43f5_b526_e1a94f6615aa

static final int IID91c2edf4_6e2c_43f5_b526_e1a94f6615aa

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getParent

IGPEnvironmentManager getParent()
                                throws java.io.IOException,
                                       AutomationException

Returns the parent environment manager.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParentByRef

void setParentByRef(IGPEnvironmentManager parent)
                    throws java.io.IOException,
                           AutomationException

Returns the parent environment manager.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addEnvironment

void addEnvironment(IGPEnvironment env)
                    throws java.io.IOException,
                           AutomationException

Adds the given geoprocessing environment to the environment manager.

Parameters:

env - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeEnvironment

void removeEnvironment(IGPEnvironment env)
                       throws java.io.IOException,
                              AutomationException

Removes the given geoprocessing environment from the environment manager.

Parameters:

env - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

substituteEnvironments

void substituteEnvironments(IArray pParams)
                            throws java.io.IOException,
                                   AutomationException

Substitues the values of the given array of parameters with the current environment values.

Parameters:

pParams - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeEnvironments

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

Removes all environments from the environment manager.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEnvironments

IArray getEnvironments()
                       throws java.io.IOException,
                              AutomationException

Returns the environments of the environment manager as an array.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocalEnvironments

IArray getLocalEnvironments()
                            throws java.io.IOException,
                                   AutomationException

Returns an array of the environments that have been updated locally.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findEnvironment

IGPEnvironment findEnvironment(java.lang.String name)
                               throws java.io.IOException,
                                      AutomationException

Locates and returns the environment with the specified name.

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putEnvVariant

void putEnvVariant(IGPEnvironment env,
                   java.lang.Object value)
                   throws java.io.IOException,
                          AutomationException

Sets the value of the given environment to the given variant.

Parameters:

env - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEnvVariant

java.lang.Object getEnvVariant(IGPEnvironment env)
                               throws java.io.IOException,
                                      AutomationException

Returns the value of the given environment as a variant.

Parameters:

env - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPersistAll

void setPersistAll(boolean rhs1)
                   throws java.io.IOException,
                          AutomationException

Indicates whether all environments or only local environments are persisted.

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.