com.esri.arcgis.arcweb
Interface IArcWebGeographyIDOptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcWebGeographyIDOptions

public interface IArcWebGeographyIDOptions
extends Serializable

Provides access to members that describe the parameters for finding IDs for a specific geography.

Product Availability

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


Method Summary
 int getCount()
          The returned number of records.
 int getFilter()
          A geographic filter for limiting the returned IDs.
 String getFilterLevel()
          Reserved for future use.
 String getKeyword()
          A case sensitive geography name.
 int getOutputLevel()
          The geography level for the IDs.
 int getStartIndex()
          The number of records to skip.
 void setCount(int count)
          The returned number of records.
 void setFilter(int filter)
          A geographic filter for limiting the returned IDs.
 void setFilterLevel(String filterLevel)
          Reserved for future use.
 void setKeyword(String keyword)
          A case sensitive geography name.
 void setOutputLevel(int outputLevel)
          The geography level for the IDs.
 void setStartIndex(int startIndex)
          The number of records to skip.
 

Method Detail

getFilter

int getFilter()
              throws IOException,
                     AutomationException
A geographic filter for limiting the returned IDs.

Product Availability

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

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

setFilter

void setFilter(int filter)
               throws IOException,
                      AutomationException
A geographic filter for limiting the returned IDs.

Product Availability

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

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

getFilterLevel

String getFilterLevel()
                      throws IOException,
                             AutomationException
Reserved for future use.

Product Availability

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

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

setFilterLevel

void setFilterLevel(String filterLevel)
                    throws IOException,
                           AutomationException
Reserved for future use.

Product Availability

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

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

getKeyword

String getKeyword()
                  throws IOException,
                         AutomationException
A case sensitive geography name.

Product Availability

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

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

setKeyword

void setKeyword(String keyword)
                throws IOException,
                       AutomationException
A case sensitive geography name.

Product Availability

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

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

getOutputLevel

int getOutputLevel()
                   throws IOException,
                          AutomationException
The geography level for the IDs.

Product Availability

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

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

setOutputLevel

void setOutputLevel(int outputLevel)
                    throws IOException,
                           AutomationException
The geography level for the IDs.

Product Availability

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

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

getCount

int getCount()
             throws IOException,
                    AutomationException
The returned number of records.

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.

setCount

void setCount(int count)
              throws IOException,
                     AutomationException
The returned number of records.

Product Availability

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

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

getStartIndex

int getStartIndex()
                  throws IOException,
                         AutomationException
The number of records to skip.

Product Availability

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

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

setStartIndex

void setStartIndex(int startIndex)
                   throws IOException,
                          AutomationException
The number of records to skip.

Product Availability

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

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