com.esri.arcgis.geoprocessing
Interface IGPParameter

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IGPParameter2, IGPParameter3

All Known Implementing Classes:

GPParameter, IGPParameter2Proxy, IGPParameter3Proxy, IGPParameterProxy, MdParameter

public interface IGPParameter
extends java.io.Serializable

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

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

Method Summary

java.lang.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.
java.lang.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.
java.lang.String	getDisplayName() Display name of the geoprocessing parameter.
int	getDisplayOrder() The display order of the geoprocessing parameter.
IGPDomain	getDomain() Domain of the geoprocessing parameter.
java.lang.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).

Field Detail

IID40ef6d06_4e62_4b3d_98e6_85f7a0607730

static final int IID40ef6d06_4e62_4b3d_98e6_85f7a0607730

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 parameter.

Returns:

The name

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 parameter.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDirection

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

Direction of the geoprocessing parameter.

Returns:

A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant

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 the geoprocessing parameter.

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.

getParameterType

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

Type of the geoprocessing parameter.

Returns:

A com.esri.arcgis.geoprocessing.esriGPParameterType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameterDependencies

IEnumBSTR getParameterDependencies()
                                   throws java.io.IOException,
                                          AutomationException

Enumeration of parameter names the geoprocessing parameter 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.

getDomain

IGPDomain getDomain()
                    throws java.io.IOException,
                           AutomationException

Domain of the geoprocessing parameter.

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.

isEnabled

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

Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.

Returns:

The enabled

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

The current value object of the geoprocessing parameter.

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.

getControlCLSID

IUID getControlCLSID()
                     throws java.io.IOException,
                            AutomationException

The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.

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.

getDefaultEnvironmentName

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

The name of the environment value to use as the default value for the geoprocessing parameter.

Returns:

The name

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

The display order of the geoprocessing parameter.

Returns:

The displayOrder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAltered

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

Indicates whether the parameter value has been explicitly set (by the user).

Returns:

The altered

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasBeenValidated

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

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

Returns:

The validated

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 parameter.

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getChoiceList

IGPChoiceList getChoiceList()
                            throws java.io.IOException,
                                   AutomationException

The choice list object of the geoprocessing parameter.

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPChoiceList

Throws:

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

AutomationException - If the ArcObject component throws an exception.