com.esri.arcgis.geoprocessing
Interface IGPParameterInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPParameterInfo

public interface IGPParameterInfo
extends Serializable

Provides access to the properties/methods of the parameter information.

Product Availability

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

Method Summary

String	getCategory() The parameter category.
IStringArray	getChoiceList() The parameter choice list.
String	getDataType() The parameter data type.
int	getDirection() The parameter direction.
String	getDisplayName() The parameter display name.
String	getName() The parameter name.
int	getParameterType() The parameter type.
IGPValue	getValue() The parameter value.
void	setCategory(String category) The parameter category.
void	setChoiceListByRef(IStringArray ppChoiceList) The parameter choice list.
void	setDataType(String type) The parameter data type.
void	setDirection(int direction) The parameter direction.
void	setDisplayName(String name) The parameter display name.
void	setName(String name) The parameter name.
void	setParameterType(int paramtype) The parameter type.
void	setValueByRef(IGPValue ppValue) The parameter value.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The parameter name.

Product Availability

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

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

The parameter name.

Product Availability

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

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

The parameter display name.

Product Availability

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

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

The parameter display name.

Product Availability

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

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

The parameter category.

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.

setCategory

void setCategory(String category)
                 throws IOException,
                        AutomationException

The parameter category.

Product Availability

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

Parameters:

category - The category (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

String getDataType()
                   throws IOException,
                          AutomationException

The parameter data type.

Product Availability

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

Returns:

The type

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataType

void setDataType(String type)
                 throws IOException,
                        AutomationException

The parameter data type.

Product Availability

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

Parameters:

type - The type (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirection

int getDirection()
                 throws IOException,
                        AutomationException

The parameter direction.

Product Availability

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

Returns:

A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirection

void setDirection(int direction)
                  throws IOException,
                         AutomationException

The parameter direction.

Product Availability

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

Parameters:

direction - A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterType

int getParameterType()
                     throws IOException,
                            AutomationException

The parameter type.

Product Availability

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

Returns:

A com.esri.arcgis.geoprocessing.esriGPParameterType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterType

void setParameterType(int paramtype)
                      throws IOException,
                             AutomationException

The parameter type.

Product Availability

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

Parameters:

paramtype - A com.esri.arcgis.geoprocessing.esriGPParameterType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChoiceList

IStringArray getChoiceList()
                           throws IOException,
                                  AutomationException

The parameter choice list.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChoiceListByRef

void setChoiceListByRef(IStringArray ppChoiceList)
                        throws IOException,
                               AutomationException

The parameter choice list.

Product Availability

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

Parameters:

ppChoiceList - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

IGPValue getValue()
                  throws IOException,
                         AutomationException

The parameter value.

Product Availability

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

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 ppValue)
                   throws IOException,
                          AutomationException

The parameter value.

Product Availability

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

Parameters:

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