com.esri.arcgis.catalogUI
Interface ISearchEngine

All Superinterfaces:

Serializable

All Known Implementing Classes:

CatalogSearchEngine, FileSystemXmlSearchEngine, ISearchEngineProxy, MetadataServiceEngine

public interface ISearchEngine
extends Serializable

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

Product Availability

Available with ArcGIS Desktop.

Method Summary

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

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the search engine.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

void setEnabled(boolean isEnabled)
                throws IOException,
                       AutomationException

Indicates if the search engine is enabled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

isEnabled - The isEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates if the search engine is enabled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryByRef

void setQueryByRef(IQuery rhs1)
                   throws IOException,
                          AutomationException

Query that will be executed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

void executeAsynchronous()
                         throws IOException,
                                AutomationException

Executes the query asynchronously.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

void stop()
          throws IOException,
                 AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExecuting

boolean isExecuting()
                    throws IOException,
                           AutomationException

Indicates if the search is currently executing.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isExecuting

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.