com.esri.arcgis.geoprocessing
Interface IMdList

All Superinterfaces:
Serializable
All Known Implementing Classes:
MdVariable

public interface IMdList
extends Serializable

Provides access to properties/methods of a model list.

Product Availability

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


Method Summary
 void addValue(IGPValue pValue)
          Adds a value.
 int getAlteredFlag(int index)
          Indicates whether the value has been explicitly set (by the user).
 int getCount()
          The list count.
 int getCurrentIndex()
          The current index.
 IMdVariable getFeedbackVariable()
          Feedback variable.
 int getListType()
          Indicates the list type.
 int getValence()
          Get valence.
 IGPValue getValue(int index)
          The value at the specifed index.
 void getValues(boolean bClone, IArray[] ppValues, ILongArray[] ppFlags)
          The values.
 void insertValue(int index, IGPValue pValue)
          Inserts a value.
 boolean isAlteredFlag()
          Indicates whether the value has been explicitly set (by the user).
 void moveValue(int index, int direction)
          Moves the specified value.
 void removeAll()
          Removes all values.
 void removeValue(int index)
          Removes the specified value.
 void setAlteredFlag(boolean altered)
          Indicates whether the value has been explicitly set (by the user).
 void setAlteredFlag2(int index, int flag)
          Indicates whether the value has been explicitly set (by the user).
 void setCurrentIndex(int index)
          The current index.
 void setFeedbackVariableByRef(IMdVariable ppVariable)
          Feedback variable.
 void setListType(int type)
          Indicates the list type.
 void setValence(int valence)
          Set valence.
 void setValueByRef(int index, IGPValue ppValue)
          The value at the specifed index.
 void setValues(IArray pValues, ILongArray pFlags)
          The values.
 

Method Detail

getListType

int getListType()
                throws IOException,
                       AutomationException
Indicates the list type.

Product Availability

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

Returns:
A com.esri.arcgis.geoprocessing.esriMdListType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setListType

void setListType(int type)
                 throws IOException,
                        AutomationException
Indicates the list type.

Product Availability

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

Parameters:
type - A com.esri.arcgis.geoprocessing.esriMdListType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentIndex

int getCurrentIndex()
                    throws IOException,
                           AutomationException
The current index.

Product Availability

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

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

setCurrentIndex

void setCurrentIndex(int index)
                     throws IOException,
                            AutomationException
The current index.

Product Availability

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

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

getCount

int getCount()
             throws IOException,
                    AutomationException
The list count.

Product Availability

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

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

getValue

IGPValue getValue(int index)
                  throws IOException,
                         AutomationException
The value at the specifed index.

Product Availability

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

Parameters:
index - The index (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.

setValueByRef

void setValueByRef(int index,
                   IGPValue ppValue)
                   throws IOException,
                          AutomationException
The value at the specifed index.

Product Availability

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

Parameters:
index - The index (in)
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.

addValue

void addValue(IGPValue pValue)
              throws IOException,
                     AutomationException
Adds a value.

Product Availability

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

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

insertValue

void insertValue(int index,
                 IGPValue pValue)
                 throws IOException,
                        AutomationException
Inserts a value.

Product Availability

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

Parameters:
index - The index (in)
pValue - 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.

moveValue

void moveValue(int index,
               int direction)
               throws IOException,
                      AutomationException
Moves the specified value.

Product Availability

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

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

removeValue

void removeValue(int index)
                 throws IOException,
                        AutomationException
Removes the specified value.

Product Availability

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

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

removeAll

void removeAll()
               throws IOException,
                      AutomationException
Removes all values.

Product Availability

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

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

getValues

void getValues(boolean bClone,
               IArray[] ppValues,
               ILongArray[] ppFlags)
               throws IOException,
                      AutomationException
The values.

Product Availability

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

Parameters:
bClone - The bClone (in)
ppValues - A reference to a com.esri.arcgis.system.IArray (out: use single element array)
ppFlags - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValues

void setValues(IArray pValues,
               ILongArray pFlags)
               throws IOException,
                      AutomationException
The values.

Product Availability

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

Parameters:
pValues - A reference to a com.esri.arcgis.system.IArray (in)
pFlags - A reference to a com.esri.arcgis.system.ILongArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeedbackVariable

IMdVariable getFeedbackVariable()
                                throws IOException,
                                       AutomationException
Feedback variable.

Product Availability

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

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

setFeedbackVariableByRef

void setFeedbackVariableByRef(IMdVariable ppVariable)
                              throws IOException,
                                     AutomationException
Feedback variable.

Product Availability

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

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

getValence

int getValence()
               throws IOException,
                      AutomationException
Get valence.

Product Availability

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

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

setValence

void setValence(int valence)
                throws IOException,
                       AutomationException
Set valence.

Product Availability

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

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

isAlteredFlag

boolean isAlteredFlag()
                      throws IOException,
                             AutomationException
Indicates whether the value has been explicitly set (by the user).

Product Availability

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

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

setAlteredFlag

void setAlteredFlag(boolean altered)
                    throws IOException,
                           AutomationException
Indicates whether the value has been explicitly set (by the user).

Product Availability

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

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

getAlteredFlag

int getAlteredFlag(int index)
                   throws IOException,
                          AutomationException
Indicates whether the value has been explicitly set (by the user).

Product Availability

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

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

setAlteredFlag2

void setAlteredFlag2(int index,
                     int flag)
                     throws IOException,
                            AutomationException
Indicates whether the value has been explicitly set (by the user).

Product Availability

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

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