com.esri.arcgis.geodatabase
Interface IGPVariable

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPVariable, MdVariable

public interface IGPVariable
extends Serializable

Provides access to properties of a geoprocessing variable.

Product Availability

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

Method Summary

IGPDataType	getDataType() The data type of the variable.
String	getName() The name of the geoprocessing variable.
IGPValue	getValue() The value object associated with the variable.
boolean	isDerived() Indicates if the variable is type derived.
void	setDataTypeByRef(IGPDataType dataType) The data type of the variable.
void	setDerived(boolean derived) Indicates if the variable is type derived.
void	setName(String name) The name of the geoprocessing variable.
void	setValueByRef(IGPValue value) The value object associated with the variable.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the geoprocessing variable.

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 name of the geoprocessing variable.

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.

getValue

IGPValue getValue()
                  throws IOException,
                         AutomationException

The value object associated with the variable.

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

The value object associated with the variable.

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.

getDataType

IGPDataType getDataType()
                        throws IOException,
                               AutomationException

The data type of the variable.

Product Availability

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

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

The data type of the variable.

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.

isDerived

boolean isDerived()
                  throws IOException,
                         AutomationException

Indicates if the variable is type derived.

Product Availability

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

Returns:

The derived

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDerived

void setDerived(boolean derived)
                throws IOException,
                       AutomationException

Indicates if the variable is type derived.

Product Availability

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

Parameters:

derived - The derived (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.