com.esri.arcgis.geoprocessing
Interface IGPEnvironment

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPEnvironment

public interface IGPEnvironment
extends Serializable

Provides access to the editable properties/methods of a geoprocessing environment object.

When To Use

The IGPEnvironment interface is used to define the properties and methods of a geoprocessing environment setting. Examples are the Extent, Current Workspace, and the Output Coordinate System. For more detail, please refer to the technical document: Building Geoprocessing Function Tools.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void addDependency(String name)
          Adds the name of an environment that the geoprocessing environment is dependent on.
 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.
 String getDisplayName()
          Display name of the geoprocessing environment.
 int getDisplayOrder()
          Display order of the geoprocessing environment.
 IGPDomain getDomain()
          Domain of the geoprocessing environment.
 String getMetadataFile()
          Name of the (XML) file containing the default metadata for this environment object.
 String getName()
          Name of the geoprocessing environment.
 IGPValue getValue()
          Value of the geoprocessing environment.
 void setCategory(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(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(String file)
          Name of the (XML) file containing the default metadata for this environment object.
 void setName(String name)
          Name of the geoprocessing environment.
 void setValueByRef(IGPValue value)
          Value of the geoprocessing environment.
 

Method Detail

getName

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

Remarks

The Name property sets the name of an environment setting. This name appears when using the environment at the command line or in scripting. It must be unique and must not contain any spaces.

Product Availability

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

Supported Platforms

Windows

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

setName

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

Product Availability

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

Supported Platforms

Windows

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

getDisplayName

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

Remarks

The DisplayName property sets the user-friendly name of an environment setting. It is displayed in the graphic user interface of the Environment Settings dialog. The DisplayName can be internationalized.

Product Availability

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

Supported Platforms

Windows

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

setDisplayName

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

Product Availability

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

Supported Platforms

Windows

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

getCategory

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

Remarks

Currently the GPEnvironment object has 5 defined categories. Use the Category property to access one of those categories.

Product Availability

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

Supported Platforms

Windows

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

setCategory

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

Product Availability

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

Supported Platforms

Windows

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

getValue

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

Remarks

The Value property returns the value of this environment setting such as the path string for the Current Workspace.

Product Availability

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

Supported Platforms

Windows

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

setValueByRef

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

Product Availability

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

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

getDomain

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

Remarks

The Domain property returns the domain of Value objects associated with the environment. It is used during validation to ensure only acceptable values are used.

Product Availability

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

Supported Platforms

Windows

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

setDomainByRef

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

Product Availability

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

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

getDataType

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

Remarks

The DataType property is used to access the DataType object associated with this Environment object.

Product Availability

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

Supported Platforms

Windows

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

setDataTypeByRef

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

Product Availability

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

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

getDisplayOrder

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

Product Availability

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

Supported Platforms

Windows

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

setDisplayOrder

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

Product Availability

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

Supported Platforms

Windows

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

getControlCLSID

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

Product Availability

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

Supported Platforms

Windows

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

setControlCLSID

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

Product Availability

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

Supported Platforms

Windows

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

getDependencies

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

Description

The Dependencies property returns a list, or enumeration [IEnumBSTR], of environment names the environment is dependent on. Dependency examples are

Product Availability

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

Supported Platforms

Windows

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

setDependencies

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

Product Availability

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

Supported Platforms

Windows

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

addDependency

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

Product Availability

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

Supported Platforms

Windows

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

getMetadataFile

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

Remarks

The MetadataFile property stores the name of a .xml file with the default metadata for an environment setting. The .xml file supplies parameter descriptions in the help panel of the Environment Settings dialog.

Product Availability

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

Supported Platforms

Windows

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

setMetadataFile

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

Product Availability

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

Supported Platforms

Windows

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