com.esri.arcgis.search
Interface IGPItemIndexer

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPItemIndexer

public interface IGPItemIndexer
extends Serializable

Provides access to GP Indexer.

Method Summary

void	addItemInfo(IItemInfo pItemInfo, boolean replaceItems, String indexPath, String sDEConnection, String[] pGuid) Add ItemInfo to Index File.
void	deleteItemInfo(String indexPath, String pGuid) Delete ItemInfo from Index File.
int	getCount() Total indexed items count.
String	getIndexFolder() Name of the index folder.
String	getIndexName() Name of the index.
String	getSDEConnection() SDE Connection file.
void	indexItem(String path) Index Item without children with passed in catalogpath.
void	indexItems(String path, boolean replaceIndex, boolean recursive, boolean useStaging, String indexPath, boolean useQueue) The Build ItemInfos..
boolean	isAncestorRegistered(IItemInfo pItemInfo) Indicates whether the ancestor of this ItemInfo has been registered to be indexed.
boolean	isHasBeenIndexed(IItemInfo pItemInfo) Indicates whether the current item has been indexed.
boolean	isUseQueue() Indicates whether queue is used during index.
boolean	isUseStaging() Indicates whether staging is used during index.
void	setIndexFolder(String pFolderName) Name of the index folder.
void	setIndexName(String pName) Name of the index.
void	setSDEConnection(String pName) SDE Connection file.
void	setUseQueue(boolean useQueue) Indicates whether queue is used during index.
void	setUseStaging(boolean pUseStaging) Indicates whether staging is used during index.
void	updateItemInfo(IItemInfo pItemInfo) Update the index.
void	updateThumbnailInIndex(String path) Update Thumbnail of a ItemInfo by passing in a catalogpath.

Method Detail

indexItems

void indexItems(String path,
                boolean replaceIndex,
                boolean recursive,
                boolean useStaging,
                String indexPath,
                boolean useQueue)
                throws IOException,
                       AutomationException

The Build ItemInfos..

Parameters:

path - The path (in)

replaceIndex - The replaceIndex (in)

recursive - The recursive (in)

useStaging - The useStaging (in)

indexPath - The indexPath (in)

useQueue - The useQueue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addItemInfo

void addItemInfo(IItemInfo pItemInfo,
                 boolean replaceItems,
                 String indexPath,
                 String sDEConnection,
                 String[] pGuid)
                 throws IOException,
                        AutomationException

Add ItemInfo to Index File.

Parameters:

pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in)

replaceItems - The replaceItems (in)

indexPath - The indexPath (in)

sDEConnection - The sDEConnection (in)

pGuid - The pGuid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteItemInfo

void deleteItemInfo(String indexPath,
                    String pGuid)
                    throws IOException,
                           AutomationException

Delete ItemInfo from Index File.

Parameters:

indexPath - The indexPath (in)

pGuid - The pGuid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateItemInfo

void updateItemInfo(IItemInfo pItemInfo)
                    throws IOException,
                           AutomationException

Update the index.

Parameters:

pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

indexItem

void indexItem(String path)
               throws IOException,
                      AutomationException

Index Item without children with passed in catalogpath.

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateThumbnailInIndex

void updateThumbnailInIndex(String path)
                            throws IOException,
                                   AutomationException

Update Thumbnail of a ItemInfo by passing in a catalogpath.

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

Total indexed items count.

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAncestorRegistered

boolean isAncestorRegistered(IItemInfo pItemInfo)
                             throws IOException,
                                    AutomationException

Indicates whether the ancestor of this ItemInfo has been registered to be indexed.

Parameters:

pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in)

Returns:

The pRegistered

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasBeenIndexed

boolean isHasBeenIndexed(IItemInfo pItemInfo)
                         throws IOException,
                                AutomationException

Indicates whether the current item has been indexed.

Parameters:

pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in)

Returns:

The pIndexed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseStaging

boolean isUseStaging()
                     throws IOException,
                            AutomationException

Indicates whether staging is used during index.

Returns:

The pUseStaging

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseStaging

void setUseStaging(boolean pUseStaging)
                   throws IOException,
                          AutomationException

Indicates whether staging is used during index.

Parameters:

pUseStaging - The pUseStaging (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseQueue

boolean isUseQueue()
                   throws IOException,
                          AutomationException

Indicates whether queue is used during index.

Returns:

The useQueue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseQueue

void setUseQueue(boolean useQueue)
                 throws IOException,
                        AutomationException

Indicates whether queue is used during index.

Parameters:

useQueue - The useQueue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexFolder

String getIndexFolder()
                      throws IOException,
                             AutomationException

Name of the index folder.

Returns:

The pFolderName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexFolder

void setIndexFolder(String pFolderName)
                    throws IOException,
                           AutomationException

Name of the index folder.

Parameters:

pFolderName - The pFolderName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexName

String getIndexName()
                    throws IOException,
                           AutomationException

Name of the index.

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexName

void setIndexName(String pName)
                  throws IOException,
                         AutomationException

Name of the index.

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSDEConnection

String getSDEConnection()
                        throws IOException,
                               AutomationException

SDE Connection file.

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSDEConnection

void setSDEConnection(String pName)
                      throws IOException,
                             AutomationException

SDE Connection file.

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.