com.esri.arcgis.catalogUI
Class ISearchEngineProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.catalogUI.ISearchEngineProxy

All Implemented Interfaces:

ISearchEngine, Externalizable, Serializable

public class ISearchEngineProxy
extends com.esri.arcgis.interop.Dispatch
implements ISearchEngine, Serializable

Provides access to members that control the operation of the search engine.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ISearchEngineProxy()
	ISearchEngineProxy(Object obj)
protected	ISearchEngineProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	executeAsynchronous() Executes the query asynchronously.
String	getName() Name of the search engine.
boolean	isEnabled() Indicates if the search engine is enabled.
boolean	isExecuting() Indicates if the search is currently executing.
void	removeListener(String iidStr, Object theListener)
void	setEnabled(boolean isEnabled) Indicates if the search engine is enabled.
void	setQueryByRef(IQuery rhs1) Query that will be executed.
void	stop() Cancels an ongoing search (if it is currently executing).

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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ISearchEngineProxy

public ISearchEngineProxy()

ISearchEngineProxy

public ISearchEngineProxy(Object obj)
                   throws IOException

Throws:

IOException

ISearchEngineProxy

protected ISearchEngineProxy(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

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the search engine.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface ISearchEngine

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

public void setEnabled(boolean isEnabled)
                throws IOException,
                       AutomationException

Indicates if the search engine is enabled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setEnabled in interface ISearchEngine

Parameters:

isEnabled - The isEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates if the search engine is enabled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isEnabled in interface ISearchEngine

Returns:

The isEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryByRef

public void setQueryByRef(IQuery rhs1)
                   throws IOException,
                          AutomationException

Query that will be executed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setQueryByRef in interface ISearchEngine

Parameters:

rhs1 - A reference to a com.esri.arcgis.catalog.IQuery (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

executeAsynchronous

public void executeAsynchronous()
                         throws IOException,
                                AutomationException

Executes the query asynchronously.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

executeAsynchronous in interface ISearchEngine

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

public void stop()
          throws IOException,
                 AutomationException

Cancels an ongoing search (if it is currently executing).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

stop in interface ISearchEngine

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExecuting

public boolean isExecuting()
                    throws IOException,
                           AutomationException

Indicates if the search is currently executing.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isExecuting in interface ISearchEngine

Returns:

The isExecuting

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.