com.esri.arcgis.catalogUI
Interface ISearchEngine

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CatalogSearchEngine, FileSystemXmlSearchEngine, ISearchEngineProxy, MetadataServiceEngine

public interface ISearchEngine
extends java.io.Serializable

COM Interface 'ISearchEngine'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriCatalogUI.olb'

Description: 'Provides access to members that control the operation of the search engine.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDd18306a2_9d3c_11d3_a6cb_0008c7d3ae50
static int	xxDummy Deprecated. Internal use only

Method Summary

void	executeAsynchronous() Executes the query asynchronously.
java.lang.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).

Field Detail

IIDd18306a2_9d3c_11d3_a6cb_0008c7d3ae50

static final int IIDd18306a2_9d3c_11d3_a6cb_0008c7d3ae50

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the search engine.

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

void setEnabled(boolean isEnabled)
                throws java.io.IOException,
                       AutomationException

Indicates if the search engine is enabled.

Parameters:

isEnabled - The isEnabled (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException

Indicates if the search engine is enabled.

Returns:

The isEnabled

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryByRef

void setQueryByRef(IQuery rhs1)
                   throws java.io.IOException,
                          AutomationException

Query that will be executed.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

executeAsynchronous

void executeAsynchronous()
                         throws java.io.IOException,
                                AutomationException

Executes the query asynchronously.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

void stop()
          throws java.io.IOException,
                 AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExecuting

boolean isExecuting()
                    throws java.io.IOException,
                           AutomationException

Indicates if the search is currently executing.

Returns:

The isExecuting

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.