com.esri.arcgis.arcweb
Class ArcWebGeographyIDOptions

java.lang.Object
  com.esri.arcgis.arcweb.ArcWebGeographyIDOptions

All Implemented Interfaces:

IArcWebGeographyIDOptions, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebGeographyIDOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebGeographyIDOptions

A set of parameters used in finding IDs for a specific geography.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArcWebGeographyIDOptions()
Constructs a ArcWebGeographyIDOptions using ArcGIS Engine.

ArcWebGeographyIDOptions(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebGeographyIDOptions theArcWebGeographyIDOptions = (ArcWebGeographyIDOptions) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ArcWebGeographyIDOptions

public ArcWebGeographyIDOptions()
                         throws IOException,
                                UnknownHostException

Constructs a ArcWebGeographyIDOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcWebGeographyIDOptions

public ArcWebGeographyIDOptions(Object obj)
                         throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebGeographyIDOptions theArcWebGeographyIDOptions = (ArcWebGeographyIDOptions) obj;

Construct a ArcWebGeographyIDOptions using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebGeographyIDOptions.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getFilter

public int getFilter()
              throws IOException,
                     AutomationException

A geographic filter for limiting the returned IDs.

Product Availability

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

Specified by:

getFilter in interface IArcWebGeographyIDOptions

Returns:

A com.esri.arcgis.arcweb.esriArcWebGeographyLevel constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilter

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

Specified by:

setFilter in interface IArcWebGeographyIDOptions

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

public String getFilterLevel()
                      throws IOException,
                             AutomationException

Reserved for future use.

Product Availability

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

Specified by:

getFilterLevel in interface IArcWebGeographyIDOptions

Returns:

The filterLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilterLevel

public void setFilterLevel(String filterLevel)
                    throws IOException,
                           AutomationException

Reserved for future use.

Product Availability

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

Specified by:

setFilterLevel in interface IArcWebGeographyIDOptions

Parameters:

filterLevel - The filterLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyword

public String getKeyword()
                  throws IOException,
                         AutomationException

A case sensitive geography name.

Product Availability

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

Specified by:

getKeyword in interface IArcWebGeographyIDOptions

Returns:

The keyword

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeyword

public void setKeyword(String keyword)
                throws IOException,
                       AutomationException

A case sensitive geography name.

Product Availability

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

Specified by:

setKeyword in interface IArcWebGeographyIDOptions

Parameters:

keyword - The keyword (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputLevel

public int getOutputLevel()
                   throws IOException,
                          AutomationException

The geography level for the IDs.

Product Availability

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

Specified by:

getOutputLevel in interface IArcWebGeographyIDOptions

Returns:

A com.esri.arcgis.arcweb.esriArcWebGeographyLevel constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputLevel

public void setOutputLevel(int outputLevel)
                    throws IOException,
                           AutomationException

The geography level for the IDs.

Product Availability

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

Specified by:

setOutputLevel in interface IArcWebGeographyIDOptions

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

public int getCount()
             throws IOException,
                    AutomationException

The returned number of records.

Product Availability

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

Specified by:

getCount in interface IArcWebGeographyIDOptions

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCount

public void setCount(int count)
              throws IOException,
                     AutomationException

The returned number of records.

Product Availability

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

Specified by:

setCount in interface IArcWebGeographyIDOptions

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartIndex

public int getStartIndex()
                  throws IOException,
                         AutomationException

The number of records to skip.

Product Availability

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

Specified by:

getStartIndex in interface IArcWebGeographyIDOptions

Returns:

The startIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartIndex

public void setStartIndex(int startIndex)
                   throws IOException,
                          AutomationException

The number of records to skip.

Product Availability

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

Specified by:

setStartIndex in interface IArcWebGeographyIDOptions

Parameters:

startIndex - The startIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.