com.esri.arcgis.carto
Interface IParameterInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

IParameterInfoProxy

public interface IParameterInfo
extends Serializable

Provides generic access to object parameters for GP framework.

Product Availability

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

Method Summary

IGPDataType	getDataType(int indexParam) Get parameter type.
int	getDependency(int indexParam) Get parameter dependency.
IGPDomain	getDomain(int indexParam) Get parameter domain.
String	getLabel(int indexParam) Gets parameter label.
String	getName(int indexParam) Gets parameter name.
String	getObjectLabel() Gets object UI label.
String	getObjectSubType() Gets object sub-type name.
String	getObjectType() Gets object type name.
int	getParameterCount() Number of exposed parameters.
IGPValue	getValue(int indexParam) Gets parameter value.
boolean	isOptional(int indexParam) Get parameter optional flag.
void	setValue(int indexParam, IGPValue ppGPValue) Gets parameter value.

Method Detail

getParameterCount

int getParameterCount()
                      throws IOException,
                             AutomationException

Number of exposed parameters.

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName(int indexParam)
               throws IOException,
                      AutomationException

Gets parameter name.

Product Availability

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

Parameters:

indexParam - The indexParam (in)

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

String getLabel(int indexParam)
                throws IOException,
                       AutomationException

Gets parameter label.

Product Availability

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

Parameters:

indexParam - The indexParam (in)

Returns:

The pLabel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

IGPDataType getDataType(int indexParam)
                        throws IOException,
                               AutomationException

Get parameter type.

Product Availability

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

Parameters:

indexParam - The indexParam (in)

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.

getDomain

IGPDomain getDomain(int indexParam)
                    throws IOException,
                           AutomationException

Get parameter domain.

Product Availability

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

Parameters:

indexParam - The indexParam (in)

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.

getDependency

int getDependency(int indexParam)
                  throws IOException,
                         AutomationException

Get parameter dependency.

Product Availability

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

Parameters:

indexParam - The indexParam (in)

Returns:

The pIndexDependency

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOptional

boolean isOptional(int indexParam)
                   throws IOException,
                          AutomationException

Get parameter optional flag.

Product Availability

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

Parameters:

indexParam - The indexParam (in)

Returns:

The pOptional

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

IGPValue getValue(int indexParam)
                  throws IOException,
                         AutomationException

Gets parameter value.

Product Availability

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

Parameters:

indexParam - The indexParam (in)

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.

setValue

void setValue(int indexParam,
              IGPValue ppGPValue)
              throws IOException,
                     AutomationException

Gets parameter value.

Product Availability

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

Parameters:

indexParam - The indexParam (in)

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

getObjectType

String getObjectType()
                     throws IOException,
                            AutomationException

Gets object type name.

Product Availability

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

Returns:

The pObjectTypeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectSubType

String getObjectSubType()
                        throws IOException,
                               AutomationException

Gets object sub-type name.

Product Availability

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

Returns:

The pObjectSubTypeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectLabel

String getObjectLabel()
                      throws IOException,
                             AutomationException

Gets object UI label.

Product Availability

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

Returns:

The pObjectLabel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.