com.esri.arcgis.geoprocessing
Interface IGPEnvironment

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
GPEnvironment, IGPEnvironmentProxy

public interface IGPEnvironment
extends java.io.Serializable

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

Description: 'Provides access to the editable properties/methods of a geoprocessing environment 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 IID5547046f_7777_4ab6_b52d_a7e76c824c6f
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addDependency(java.lang.String name)
          Adds the name of an environment that the geoprocessing environment is dependent on.
 java.lang.String getCategory()
          Category of the geoprocessing environment.
 IUID getControlCLSID()
          Class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing environment.
 IGPDataType getDataType()
          Data type of acceptable values of the geoprocessing environment.
 IEnumBSTR getDependencies()
          Enumeration of environment names the geoprocessing environment is dependent on.
 java.lang.String getDisplayName()
          Display name of the geoprocessing environment.
 int getDisplayOrder()
          Display order of the geoprocessing environment.
 IGPDomain getDomain()
          Domain of the geoprocessing environment.
 java.lang.String getMetadataFile()
          Name of the (XML) file containing the default metadata for this environment object.
 java.lang.String getName()
          Name of the geoprocessing environment.
 IGPValue getValue()
          Value of the geoprocessing environment.
 void setCategory(java.lang.String category)
          Category of the geoprocessing environment.
 void setControlCLSID(IUID cLSID)
          Class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing environment.
 void setDataTypeByRef(IGPDataType dataType)
          Data type of acceptable values of the geoprocessing environment.
 void setDependencies(IEnumBSTR dependencies)
          Enumeration of environment names the geoprocessing environment is dependent on.
 void setDisplayName(java.lang.String name)
          Display name of the geoprocessing environment.
 void setDisplayOrder(int displayOrder)
          Display order of the geoprocessing environment.
 void setDomainByRef(IGPDomain domain)
          Domain of the geoprocessing environment.
 void setMetadataFile(java.lang.String file)
          Name of the (XML) file containing the default metadata for this environment object.
 void setName(java.lang.String name)
          Name of the geoprocessing environment.
 void setValueByRef(IGPValue value)
          Value of the geoprocessing environment.
 

Field Detail

IID5547046f_7777_4ab6_b52d_a7e76c824c6f

static final int IID5547046f_7777_4ab6_b52d_a7e76c824c6f
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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the geoprocessing environment.

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

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Name of the geoprocessing environment.

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

getDisplayName

java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException
Display name of the geoprocessing environment.

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

setDisplayName

void setDisplayName(java.lang.String name)
                    throws java.io.IOException,
                           AutomationException
Display name of the geoprocessing environment.

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

getCategory

java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
Category of the geoprocessing environment.

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

setCategory

void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException
Category of the geoprocessing environment.

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

getValue

IGPValue getValue()
                  throws java.io.IOException,
                         AutomationException
Value of the geoprocessing environment.

Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValueByRef

void setValueByRef(IGPValue value)
                   throws java.io.IOException,
                          AutomationException
Value of the geoprocessing environment.

Parameters:
value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDomain

IGPDomain getDomain()
                    throws java.io.IOException,
                           AutomationException
Domain of the geoprocessing environment.

Returns:
A reference to a com.esri.arcgis.geodatabase.IGPDomain
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDomainByRef

void setDomainByRef(IGPDomain domain)
                    throws java.io.IOException,
                           AutomationException
Domain of the geoprocessing environment.

Parameters:
domain - A reference to a com.esri.arcgis.geodatabase.IGPDomain (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataType

IGPDataType getDataType()
                        throws java.io.IOException,
                               AutomationException
Data type of acceptable values of the geoprocessing environment.

Returns:
A reference to a com.esri.arcgis.geodatabase.IGPDataType
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataTypeByRef

void setDataTypeByRef(IGPDataType dataType)
                      throws java.io.IOException,
                             AutomationException
Data type of acceptable values of the geoprocessing environment.

Parameters:
dataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayOrder

int getDisplayOrder()
                    throws java.io.IOException,
                           AutomationException
Display order of the geoprocessing environment.

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

setDisplayOrder

void setDisplayOrder(int displayOrder)
                     throws java.io.IOException,
                            AutomationException
Display order of the geoprocessing environment.

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

getControlCLSID

IUID getControlCLSID()
                     throws java.io.IOException,
                            AutomationException
Class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing environment.

Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setControlCLSID

void setControlCLSID(IUID cLSID)
                     throws java.io.IOException,
                            AutomationException
Class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing environment.

Parameters:
cLSID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDependencies

IEnumBSTR getDependencies()
                          throws java.io.IOException,
                                 AutomationException
Enumeration of environment names the geoprocessing environment is dependent on.

Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDependencies

void setDependencies(IEnumBSTR dependencies)
                     throws java.io.IOException,
                            AutomationException
Enumeration of environment names the geoprocessing environment is dependent on.

Parameters:
dependencies - A reference to a com.esri.arcgis.system.IEnumBSTR (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addDependency

void addDependency(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
Adds the name of an environment that the geoprocessing environment is dependent on.

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

getMetadataFile

java.lang.String getMetadataFile()
                                 throws java.io.IOException,
                                        AutomationException
Name of the (XML) file containing the default metadata for this environment object.

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

setMetadataFile

void setMetadataFile(java.lang.String file)
                     throws java.io.IOException,
                            AutomationException
Name of the (XML) file containing the default metadata for this environment object.

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