com.esri.arcgis.search
Interface IIndexingConfiguration

All Superinterfaces:

Serializable

All Known Subinterfaces:

IIndexingConfiguration2

All Known Implementing Classes:

IndexingConfiguration

public interface IIndexingConfiguration
extends Serializable

Provides access to the IndexingConfiguration Interface.

Method Summary

String	getFilter() File extensions to be filtered out.
int	getFullIndexInterval() Full index interval.
int	getIncrementalIndexInterval() Incremental index interval.
IStringArray	getPaths() The target paths to be indexed.
String	getStartTime() Index start time.
boolean	isPaused() Indicates whether to pause indexing until instructed to resume.
boolean	isRecursive() Indicates whether to recursively get the children of target path.
boolean	isReplaceIndex() Indicates whether to replace existing index.
boolean	isReplaceItems() Indicates whether to replace existing items.
boolean	isSkipConnections() Indicates whether to skip connection files (sde, ags, wcs, wms, etc) copied to non-default locations.
boolean	isWasRunning() Indicates whether the indexer was running when it was paused.
void	setFilter(String pFilter) File extensions to be filtered out.
void	setFullIndexInterval(int pInterval) Full index interval.
void	setIncrementalIndexInterval(int pInterval) Incremental index interval.
void	setIsPaused(boolean pPaused) Indicates whether to pause indexing until instructed to resume.
void	setPaths(IStringArray ppPaths) The target paths to be indexed.
void	setRecursive(boolean pRecursive) Indicates whether to recursively get the children of target path.
void	setReplaceIndex(boolean pReplaceIndex) Indicates whether to replace existing index.
void	setReplaceItems(boolean pReplaceItems) Indicates whether to replace existing items.
void	setSkipConnections(boolean pSkip) Indicates whether to skip connection files (sde, ags, wcs, wms, etc) copied to non-default locations.
void	setStartTime(String startTime) Index start time.
void	setWasRunning(boolean pRunning) Indicates whether the indexer was running when it was paused.

Method Detail

getPaths

IStringArray getPaths()
                      throws IOException,
                             AutomationException

The target paths to be indexed.

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPaths

void setPaths(IStringArray ppPaths)
              throws IOException,
                     AutomationException

The target paths to be indexed.

Parameters:

ppPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

String getFilter()
                 throws IOException,
                        AutomationException

File extensions to be filtered out.

Returns:

The pFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilter

void setFilter(String pFilter)
               throws IOException,
                      AutomationException

File extensions to be filtered out.

Parameters:

pFilter - The pFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRecursive

boolean isRecursive()
                    throws IOException,
                           AutomationException

Indicates whether to recursively get the children of target path.

Returns:

The pRecursive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecursive

void setRecursive(boolean pRecursive)
                  throws IOException,
                         AutomationException

Indicates whether to recursively get the children of target path.

Parameters:

pRecursive - The pRecursive (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReplaceIndex

boolean isReplaceIndex()
                       throws IOException,
                              AutomationException

Indicates whether to replace existing index.

Returns:

The pReplaceIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplaceIndex

void setReplaceIndex(boolean pReplaceIndex)
                     throws IOException,
                            AutomationException

Indicates whether to replace existing index.

Parameters:

pReplaceIndex - The pReplaceIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReplaceItems

boolean isReplaceItems()
                       throws IOException,
                              AutomationException

Indicates whether to replace existing items.

Returns:

The pReplaceItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplaceItems

void setReplaceItems(boolean pReplaceItems)
                     throws IOException,
                            AutomationException

Indicates whether to replace existing items.

Parameters:

pReplaceItems - The pReplaceItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncrementalIndexInterval

int getIncrementalIndexInterval()
                                throws IOException,
                                       AutomationException

Incremental index interval.

Returns:

The pInterval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIncrementalIndexInterval

void setIncrementalIndexInterval(int pInterval)
                                 throws IOException,
                                        AutomationException

Incremental index interval.

Parameters:

pInterval - The pInterval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullIndexInterval

int getFullIndexInterval()
                         throws IOException,
                                AutomationException

Full index interval.

Returns:

The pInterval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullIndexInterval

void setFullIndexInterval(int pInterval)
                          throws IOException,
                                 AutomationException

Full index interval.

Parameters:

pInterval - The pInterval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTime

String getStartTime()
                    throws IOException,
                           AutomationException

Index start time.

Returns:

The startTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTime

void setStartTime(String startTime)
                  throws IOException,
                         AutomationException

Index start time.

Parameters:

startTime - The startTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSkipConnections

boolean isSkipConnections()
                          throws IOException,
                                 AutomationException

Indicates whether to skip connection files (sde, ags, wcs, wms, etc) copied to non-default locations.

Returns:

The pSkip

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSkipConnections

void setSkipConnections(boolean pSkip)
                        throws IOException,
                               AutomationException

Indicates whether to skip connection files (sde, ags, wcs, wms, etc) copied to non-default locations.

Parameters:

pSkip - The pSkip (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPaused

boolean isPaused()
                 throws IOException,
                        AutomationException

Indicates whether to pause indexing until instructed to resume.

Returns:

The pPaused

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPaused

void setIsPaused(boolean pPaused)
                 throws IOException,
                        AutomationException

Indicates whether to pause indexing until instructed to resume.

Parameters:

pPaused - The pPaused (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWasRunning

boolean isWasRunning()
                     throws IOException,
                            AutomationException

Indicates whether the indexer was running when it was paused.

Returns:

The pRunning

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWasRunning

void setWasRunning(boolean pRunning)
                   throws IOException,
                          AutomationException

Indicates whether the indexer was running when it was paused.

Parameters:

pRunning - The pRunning (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.