com.esri.arcgis.geoprocessing
Interface IGPParameter

All Superinterfaces:
Serializable
All Known Subinterfaces:
IGPParameter2, IGPParameter3
All Known Implementing Classes:
GPParameter, MdParameter

public interface IGPParameter
extends Serializable

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

Superseded By

IGPParameter3

Remarks

The IGPParameter provides access to the properties that identify the characteristics for a geoprocessing tool’s parameter. The ParameterInfo property of the IGPFunction returns an array of IGPParameter objects. Also refer to IGPParameterEdit, IGPFunction.

Product Availability

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

Supported Platforms

Windows


Method Summary
 String getCategory()
          Category of the geoprocessing parameter.
 IGPChoiceList getChoiceList()
          The choice list object of the geoprocessing parameter.
 IUID getControlCLSID()
          The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.
 IGPDataType getDataType()
          Data type of the geoprocessing parameter.
 String getDefaultEnvironmentName()
          The name of the environment value to use as the default value for the geoprocessing parameter.
 int getDirection()
          Direction of the geoprocessing parameter.
 String getDisplayName()
          Display name of the geoprocessing parameter.
 int getDisplayOrder()
          The display order of the geoprocessing parameter.
 IGPDomain getDomain()
          Domain of the geoprocessing parameter.
 String getName()
          Name of the geoprocessing parameter.
 IEnumBSTR getParameterDependencies()
          Enumeration of parameter names the geoprocessing parameter is dependent on.
 int getParameterType()
          Type of the geoprocessing parameter.
 IGPValue getValue()
          The current value object of the geoprocessing parameter.
 boolean isAltered()
          Indicates whether the parameter value has been explicitly set (by the user).
 boolean isEnabled()
          Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.
 boolean isHasBeenValidated()
          Indicates whether the parameter value has been modified since the last time the parameter was validated (i.e., since Validate() was called).
 

Method Detail

getName

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

Remarks

The Name property value must not contain any spaces; correct value examples are: "inputFeature" or "input_featureclass".

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.

getDisplayName

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

Remarks

The DisplayName property stores the parameter's name that is exposed at the UI, for example "Input Features". This value 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.

getDirection

int getDirection()
                 throws IOException,
                        AutomationException
Direction of the geoprocessing parameter.

Remarks

The Direction property is an enumeration of values for setting the direction of a parameter. Valid values are: esriGPParameterDirectionInput, esriGPParameterDirectionOutput.

Product Availability

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

Supported Platforms

Windows

Returns:
A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataType

IGPDataType getDataType()
                        throws IOException,
                               AutomationException
Data type of the geoprocessing parameter.

Remarks

The DataType property defines and manages the type of data that can be used with a parameter. Examples include: FeatureClass, String, Boolean, Raster, and Table. So, if a parameter's data type is Table, then only table data can be entered. For a complete list of data type objects, check the IGPDataType in the ArcGIS Developer Help.

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.

getParameterType

int getParameterType()
                     throws IOException,
                            AutomationException
Type of the geoprocessing parameter.

Remarks

The ParameterType property is an enumeration of values for setting a geoprocessing function parameter's type. Three values are in this enumeration: esriGPParameterTypeRequired, esriGPParameterTypeOptional, and esriGPParameterTypeDerived.

Product Availability

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

Supported Platforms

Windows

Returns:
A com.esri.arcgis.geoprocessing.esriGPParameterType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameterDependencies

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

Remarks

The ParameterDependencies property is optional; it is used to set dependencies between parameters. For example, a field parameter is typically dependent on a table or feature class.

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.

getDomain

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

Remarks

The Domain property is used to set, limit, or filter valid values for a parameter. An example of the domain (RangeDomain) for a value object is limiting an integer to the range of 1 - 100. For a complete list of valid domain objects, refer to IGPDomain in the ArcGIS Developer Help.

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.

isEnabled

boolean isEnabled()
                  throws IOException,
                         AutomationException
Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.

Remarks

The Enabled property controls whether or not a parameter is visible at the UI.

Product Availability

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

Supported Platforms

Windows

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

getValue

IGPValue getValue()
                  throws IOException,
                         AutomationException
The current value object of the geoprocessing parameter.

Remarks

The Value property defines the value of a parameter's data type. For example, if the data type is FeatureClass, then the parameter's default value is FeatureClass. Values are the actual data inputs to a geoprocessing tool, containing scalars or the path to the data on disk. For the complete list of Value objects, refer to IGPValue in the ArcGIS Develop Help.

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.

getControlCLSID

IUID getControlCLSID()
                     throws IOException,
                            AutomationException
The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.

Remarks

The ControlCLSID property is optional; it is used to override the default control of the DataType. If no CLSID is supplied, then the control of the DataType is used.

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.

getDefaultEnvironmentName

String getDefaultEnvironmentName()
                                 throws IOException,
                                        AutomationException
The name of the environment value to use as the default value for the geoprocessing parameter.

Remarks

The DefaultEnvironmentName property is optional; it initializes the default environment value for a geoprocessing tool parameter.

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.

getDisplayOrder

int getDisplayOrder()
                    throws IOException,
                           AutomationException
The display order of the geoprocessing parameter.

Remarks

The DisplayOrder is optional; it stores the order in which parameters are displayed on a dialog. The usage display order is always the order of the values in the array. For example, in the ParameterInfo property the parameters ought to be ordered by required, optional, and derived.

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.

isAltered

boolean isAltered()
                  throws IOException,
                         AutomationException
Indicates whether the parameter value has been explicitly set (by the user).

Product Availability

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

Supported Platforms

Windows

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

isHasBeenValidated

boolean isHasBeenValidated()
                           throws IOException,
                                  AutomationException
Indicates whether the parameter value has been modified since the last time the parameter was validated (i.e., since Validate() was called).

Product Availability

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

Supported Platforms

Windows

Returns:
The validated
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 parameter.

Remarks

The Category property is optional; it is creates an expandable and collapsible section on a tool dialog. Use the Category property to "hide" many optional parameters of a function.

Product Availability

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

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

getChoiceList

IGPChoiceList getChoiceList()
                            throws IOException,
                                   AutomationException
The choice list object of the geoprocessing parameter.

Remarks

The ChoiceList property is optional; it supplies a choice list for parameter values for the command line.

Product Availability

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

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