com.esri.arcgis.geoprocessing
Interface IMdParameter

All Superinterfaces:
Serializable
All Known Implementing Classes:
MdParameter

public interface IMdParameter
extends Serializable

Provides access to properties/methods of a model parameter.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void init(IGPParameter definition)
          Initializes the model parameter using the given parameter as a template.
 boolean isCurrent()
          Indicates if the model parameter is current (i.e., has been created).
 boolean isDerived()
          Indicates if the model parameter is a derived value.
 boolean isMarked()
          Indicates if the model parameter has been marked for validation/execution.
 boolean isValid()
          Indicates if the model parameter is valid.
 void setCurrent(boolean current)
          Indicates if the model parameter is current (i.e., has been created).
 void setDerived(boolean derived)
          Indicates if the model parameter is a derived value.
 void setMarked(boolean marked)
          Indicates if the model parameter has been marked for validation/execution.
 void setValid(boolean valid)
          Indicates if the model parameter is valid.
 void setValueByRef(IGPValue rhs1)
          The value of the parameter object.
 IGPMessage validate()
          Validates the current value of the model parameter.
 

Method Detail

setValueByRef

void setValueByRef(IGPValue rhs1)
                   throws IOException,
                          AutomationException
The value of the parameter object.

Product Availability

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

Parameters:
rhs1 - 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.

isMarked

boolean isMarked()
                 throws IOException,
                        AutomationException
Indicates if the model parameter has been marked for validation/execution.

Product Availability

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

Supported Platforms

Windows

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

setMarked

void setMarked(boolean marked)
               throws IOException,
                      AutomationException
Indicates if the model parameter has been marked for validation/execution.

Product Availability

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

Supported Platforms

Windows

Parameters:
marked - The marked (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

boolean isValid()
                throws IOException,
                       AutomationException
Indicates if the model parameter is valid.

Product Availability

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

Supported Platforms

Windows

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

setValid

void setValid(boolean valid)
              throws IOException,
                     AutomationException
Indicates if the model parameter is valid.

Product Availability

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

Supported Platforms

Windows

Parameters:
valid - The valid (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCurrent

boolean isCurrent()
                  throws IOException,
                         AutomationException
Indicates if the model parameter is current (i.e., has been created).

Product Availability

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

Supported Platforms

Windows

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

setCurrent

void setCurrent(boolean current)
                throws IOException,
                       AutomationException
Indicates if the model parameter is current (i.e., has been created).

Product Availability

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

Supported Platforms

Windows

Parameters:
current - The current (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 model parameter is a derived value.

Product Availability

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

Supported Platforms

Windows

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 model parameter is a derived value.

Product Availability

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

Supported Platforms

Windows

Parameters:
derived - The derived (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

init

void init(IGPParameter definition)
          throws IOException,
                 AutomationException
Initializes the model parameter using the given parameter as a template.

Product Availability

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

Supported Platforms

Windows

Parameters:
definition - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validate

IGPMessage validate()
                    throws IOException,
                           AutomationException
Validates the current value of the model parameter.

Product Availability

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

Supported Platforms

Windows

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