com.esri.arcgis.arcweb
Class IArcWebPlaceFinderOptionsProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.arcweb.IArcWebPlaceFinderOptionsProxy
All Implemented Interfaces:
IArcWebPlaceFinderOptions, Externalizable, Serializable

public class IArcWebPlaceFinderOptionsProxy
extends com.esri.arcgis.interop.Dispatch
implements IArcWebPlaceFinderOptions, Serializable

Provides access to members that control finding places.

Product Availability

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

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IArcWebPlaceFinderOptionsProxy()
           
  IArcWebPlaceFinderOptionsProxy(Object obj)
           
protected IArcWebPlaceFinderOptionsProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 int getCount()
          The number of matching records to return (default is 10).
 String getDataSource()
          The name of the data source used for finding a place (default is ArcWeb:ESRI.Gazetteer.World).
 int getFilterCountry()
          The country to search (default is esriArcWebCountryAll).
 IEnvelope getFilterExtent()
          The geographic area to search (null means no area restrictions).
 String getFilterType()
          The type of place to search (null returns all types).
 int getSearchType()
          The type of search to perform (default is esriArcWebSearchTypeStartsWith).
 int getStartIndex()
          The first matching record number to return (default is 0).
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setCount(int count)
          The number of matching records to return (default is 10).
 void setDataSource(String dataSource)
          The name of the data source used for finding a place (default is ArcWeb:ESRI.Gazetteer.World).
 void setFilterCountry(int filterCountry)
          The country to search (default is esriArcWebCountryAll).
 void setFilterExtentByRef(IEnvelope filterExtent)
          The geographic area to search (null means no area restrictions).
 void setFilterType(String filterType)
          The type of place to search (null returns all types).
 void setSearchType(int searchType)
          The type of search to perform (default is esriArcWebSearchTypeStartsWith).
 void setStartIndex(int startIndex)
          The first matching record number to return (default is 0).
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IArcWebPlaceFinderOptionsProxy

public IArcWebPlaceFinderOptionsProxy()

IArcWebPlaceFinderOptionsProxy

public IArcWebPlaceFinderOptionsProxy(Object obj)
                               throws IOException
Throws:
IOException

IArcWebPlaceFinderOptionsProxy

protected IArcWebPlaceFinderOptionsProxy(Object obj,
                                         String iid)
                                  throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getDataSource

public String getDataSource()
                     throws IOException,
                            AutomationException
The name of the data source used for finding a place (default is ArcWeb:ESRI.Gazetteer.World).

Product Availability

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

Specified by:
getDataSource in interface IArcWebPlaceFinderOptions
Returns:
The dataSource
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSource

public void setDataSource(String dataSource)
                   throws IOException,
                          AutomationException
The name of the data source used for finding a place (default is ArcWeb:ESRI.Gazetteer.World).

Product Availability

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

Specified by:
setDataSource in interface IArcWebPlaceFinderOptions
Parameters:
dataSource - The dataSource (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilterCountry

public int getFilterCountry()
                     throws IOException,
                            AutomationException
The country to search (default is esriArcWebCountryAll).

Product Availability

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

Specified by:
getFilterCountry in interface IArcWebPlaceFinderOptions
Returns:
A com.esri.arcgis.arcweb.esriArcWebCountry constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFilterCountry

public void setFilterCountry(int filterCountry)
                      throws IOException,
                             AutomationException
The country to search (default is esriArcWebCountryAll).

Product Availability

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

Specified by:
setFilterCountry in interface IArcWebPlaceFinderOptions
Parameters:
filterCountry - A com.esri.arcgis.arcweb.esriArcWebCountry constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilterExtent

public IEnvelope getFilterExtent()
                          throws IOException,
                                 AutomationException
The geographic area to search (null means no area restrictions).

Product Availability

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

Specified by:
getFilterExtent in interface IArcWebPlaceFinderOptions
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFilterExtentByRef

public void setFilterExtentByRef(IEnvelope filterExtent)
                          throws IOException,
                                 AutomationException
The geographic area to search (null means no area restrictions).

Product Availability

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

Specified by:
setFilterExtentByRef in interface IArcWebPlaceFinderOptions
Parameters:
filterExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilterType

public String getFilterType()
                     throws IOException,
                            AutomationException
The type of place to search (null returns all types).

Product Availability

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

Specified by:
getFilterType in interface IArcWebPlaceFinderOptions
Returns:
The filterType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFilterType

public void setFilterType(String filterType)
                   throws IOException,
                          AutomationException
The type of place to search (null returns all types).

Product Availability

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

Specified by:
setFilterType in interface IArcWebPlaceFinderOptions
Parameters:
filterType - The filterType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
The number of matching records to return (default is 10).

Product Availability

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

Specified by:
getCount in interface IArcWebPlaceFinderOptions
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 number of matching records to return (default is 10).

Product Availability

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

Specified by:
setCount in interface IArcWebPlaceFinderOptions
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 first matching record number to return (default is 0).

Product Availability

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

Specified by:
getStartIndex in interface IArcWebPlaceFinderOptions
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 first matching record number to return (default is 0).

Product Availability

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

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

getSearchType

public int getSearchType()
                  throws IOException,
                         AutomationException
The type of search to perform (default is esriArcWebSearchTypeStartsWith).

Product Availability

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

Specified by:
getSearchType in interface IArcWebPlaceFinderOptions
Returns:
A com.esri.arcgis.arcweb.esriArcWebSearchType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSearchType

public void setSearchType(int searchType)
                   throws IOException,
                          AutomationException
The type of search to perform (default is esriArcWebSearchTypeStartsWith).

Product Availability

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

Specified by:
setSearchType in interface IArcWebPlaceFinderOptions
Parameters:
searchType - A com.esri.arcgis.arcweb.esriArcWebSearchType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException