Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKIndexFuncStatusTS

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKIndexFuncStatusTS
All Implemented Interfaces:
java.io.Serializable

public class DKIndexFuncStatusTS
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Constructor Summary
DKIndexFuncStatusTS()
          Constructs an index function status class for TS
 
Method Summary
 int getDocMessages()
          Gets number of document messages written during indexing.
 int getDocsInPrimaryIndex()
          Gets number of documents in the primary index.
 int getDocsInSecondaryIndex()
          Gets number of documents in the secondary index.
 boolean getEnabledId()
          Gets enabled id
 java.lang.String getEndedLast()
          Gets timestamp of the last indexing end time
 boolean getFunctionStopped()
          Function stopped indicator
 java.lang.String getIndexName()
          Gets index name
 int getReasonCode()
          Gets reason code
 int getScheduledDocs()
          Gets number of indexing requests that are currently scheduled.
 java.lang.String getStartedExecution()
          Gets timestamp of the indexing start time
 java.lang.String getStartedLast()
          Gets timestamp of the last indexing start time
 boolean isCompleted()
          Indexing completed indicator
 void setDocMessages(int docMsgs)
          Sets number of document messages written during indexing.
 void setDocsInPrimaryIndex(int primaryDocs)
          Sets number of documents in the primary index.
 void setDocsInSecondaryIndex(int secondaryDocs)
          Sets number of documents in the secondary index.
 void setEnabledId(boolean enabled)
          Sets enabled id
 void setEndedLast(java.lang.String time)
          Sets timestamp of the last indexing end time
 void setFunctionStopped(boolean funcStopped)
          Sets function stopped indicator
 void setIndexName(java.lang.String indexName)
          Sets index name
 void setReasonCode(int reasonCode)
          Sets reason code
 void setScheduledDocs(int scheduledDocs)
          Sets number of indexing requests that are currently scheduled.
 void setStartedExecution(java.lang.String time)
          Sets timestamp of the indexing start time
 void setStartedLast(java.lang.String time)
          Sets timestamp of the last indexing start time
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKIndexFuncStatusTS

public DKIndexFuncStatusTS()
Constructs an index function status class for TS
Method Detail

getIndexName

public java.lang.String getIndexName()
Gets index name
Returns:
index name

setIndexName

public void setIndexName(java.lang.String indexName)
Sets index name
Parameters:
indexName - index name

getEnabledId

public boolean getEnabledId()
Gets enabled id
Returns:
true if the function is enabled

setEnabledId

public void setEnabledId(boolean enabled)
Sets enabled id
Parameters:
enabled - enabled id

setReasonCode

public void setReasonCode(int reasonCode)
Sets reason code
Parameters:
reasonCode - reason code

getReasonCode

public int getReasonCode()
Gets reason code
Returns:
reason code

isCompleted

public boolean isCompleted()
Indexing completed indicator
Returns:
true if indexing is completed properly

getFunctionStopped

public boolean getFunctionStopped()
Function stopped indicator
Returns:
true if function was stopped because of Text Search internal error.

setFunctionStopped

public void setFunctionStopped(boolean funcStopped)
Sets function stopped indicator
Parameters:
funcStopped - function stopped indicator

getStartedLast

public java.lang.String getStartedLast()
Gets timestamp of the last indexing start time
Returns:
last indexing start time

setStartedLast

public void setStartedLast(java.lang.String time)
Sets timestamp of the last indexing start time
Parameters:
time - last indexing start time

getEndedLast

public java.lang.String getEndedLast()
Gets timestamp of the last indexing end time
Returns:
indexing end time

setEndedLast

public void setEndedLast(java.lang.String time)
Sets timestamp of the last indexing end time
Parameters:
time - last indexing end time

getStartedExecution

public java.lang.String getStartedExecution()
Gets timestamp of the indexing start time
Returns:
indexing start time

setStartedExecution

public void setStartedExecution(java.lang.String time)
Sets timestamp of the indexing start time
Parameters:
time - indexing start time

setScheduledDocs

public void setScheduledDocs(int scheduledDocs)
Sets number of indexing requests that are currently scheduled.
Parameters:
scheduledDocs - number of scheduled docs

getScheduledDocs

public int getScheduledDocs()
Gets number of indexing requests that are currently scheduled.
Returns:
number of scheduled docs

setDocsInPrimaryIndex

public void setDocsInPrimaryIndex(int primaryDocs)
Sets number of documents in the primary index.
Parameters:
primaryDocs - number of documents in primary index

getDocsInPrimaryIndex

public int getDocsInPrimaryIndex()
Gets number of documents in the primary index.
Returns:
number of documents in primary index

setDocsInSecondaryIndex

public void setDocsInSecondaryIndex(int secondaryDocs)
Sets number of documents in the secondary index.
Parameters:
secondaryDocs - number of documents in secondary index

getDocsInSecondaryIndex

public int getDocsInSecondaryIndex()
Gets number of documents in the secondary index. If this number becomes large compared to the number of documents on the primary index, use the DKDatastoreAdminTS::reorgIndex function to merge the primary and secondary indexes to improve performance in searching for and indexing documents.
Returns:
number of documents in secondary index

setDocMessages

public void setDocMessages(int docMsgs)
Sets number of document messages written during indexing.
Parameters:
docMsgs - number of document messages

getDocMessages

public int getDocMessages()
Gets number of document messages written during indexing.
Returns:
number of document messages

EIP Java APIs

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