Index

DXIndexFuncStatusTS

Purpose:

This class is used to hold information about a text search indexing function status.

Methods:

getIndexName
BSTR getIndexName();

Gets the index name.

setIndexName
setIndexName(LPCTSTR indexName);

Sets the index name. The indexName is the name of a text search index.

getEnabledId
BOOL getEnabledId();

Returns the value TRUE if the function is enabled.

setEnabledId
setEnabledId(BOOL enabled);

Sets the enabledId.

getReasonCode
long getReasonCode();

Gets the reason code.

setReasonCode
setReasonCode(long reasonCode);
 

Sets the reason code.

isCompleted
BOOL isCompleted();
 

Returns TRUE if indexing has completed properly.

getFunctionStopped
BOOL getFunctionStopped();
 

Returns TRUE if the function was stopped because of a Text Search Engine internal error. Check the reason code.

setFunctionStopped
setFunctionStopped(BOOL funcStopped);
 

Sets the function stopped indicator.

getStartedLast
BSTR getStartedLast();

Returns the timestamp of the last indexing start time.

setStartedLast
setStartedLast(LPCTSTR time);

Sets the timestamp of the last indexing start time.

getEndedLast
BSTR getEndedLast();

Returns the timestamp of the last indexing end time.

setEndedLast
setEndedLast(LPCTSTR time);

Sets the timestamp of the last indexing end time.

getStartedExecution
BSTR getStartedExecution();

Returns the timestamp of the indexing execution start time.

setStartedExecution
setStartedExecution(LPCTSTR time);

Sets the timestamp of the indexing execution start time.

getScheduledDocs
long getScheduledDocs();

Gets the number of indexing requests that are currently scheduled.

setScheduledDocs
setScheduledDocs(long scheduledDocs);

Sets the number of scheduled indexing requests. This method is only used to get information into the class; this method will not update the datastore.

getDocsInPrimaryIndex
    public int getDocsInPrimaryIndex();
 

Gets the number of documents in the primary index.

setDocsInPrimaryIndex
long getDocsInPrimaryIndex();

Sets the number of documents in the primary index. This method is only used to get information into the class; this method will not update the datastore.

getDocsInSecondaryIndex
long getDocsInSecondaryIndex();

Gets the number of documents in the secondary index.

setDocsInSecondaryIndex
setDocsInSecondaryIndex(long secondaryDocs);

Sets the number of documents in the secondary index. This method is only used to get information into the class; this method will not update the datastore.

getDocMessages
long getDocMessages();

Gets the number of document messages written during indexing.

setDocMessages
setDocMessages(long docMsgs);

Sets the number of documents messages written during indexing. This method is only used to get information into the class; this method will not update the datastore.

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.