Index

DKIndexFuncStatusTS

Purpose:

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

Class summary:

    class DKIndexFuncStatusTS 
    {
   public:
      DKIndexFuncStatusTS();
      virtual ~DKIndexFuncStatusTS();
      DKString  getIndexName();
      void      setIndexName(const char* indexName);
      DKBoolean getEnabledId();
      void      setEnabledId(DKBoolean enabled);
      long      getReasonCode();
      void      setReasonCode(long reasonCode);
      DKBoolean isCompleted();
      DKBoolean getFunctionStopped();
      void      setFunctionStopped(DKBoolean funcStopped);
      DKString  getStartedLast();
      void      setStartedLast(const char* time);
      DKString  getEndedLast();
      void      setEndedLast(const char* time);
      DKString  getStartedExecution();
      void      setStartedExecution(const char* time);
      long      getScheduledDocs();
      void      setScheduledDocs(long scheduledDocs);
      long      getDocsInPrimaryIndex();
      void      setDocsInPrimaryIndex(long primaryDocs);
      long      getDocsInSecondaryIndex();
      void      setDocsInSecondaryIndex(long secondaryDocs);
      long      getDocMessages();
      void      setDocMessages(long docMsgs);
    }

Members:

Constructors and destructor
      DKIndexFuncStatusTS();
      virtual ~DKIndexFuncStatusTS();

Member functions

getIndexName
Gets the index name.
   DKString getIndexName();

setIndexName
Sets the index name. The indexName is the name of a text search index.
   void setIndexName(const char* indexName);

getEnabledId
Returns TRUE if the function is enabled.
   DKBoolean getEnabledId();

setEnabledId
Sets the enabled ID.
    void setEnabledId(DKBoolean enabled);

getReasonCode
Gets the reason code.
    long getReasonCode();

setReasonCode
Sets the reason code.
    void setReasonCode(long reasonCode);

isCompleted
Returns TRUE if indexing has completed properly.
 DKBoolean isCompleted();

getFunctionStopped
Returns TRUE if the function was stopped because of a Text Search Engine internal error. Check the reason code.
 DKBoolean getFunctionStopped();

setFunctionStopped
Sets the function stopped indicator.
    void setFunctionStopped(DKBoolean funcStopped);

getStartedLast
Returns the timestamp of the last indexing start time.
 DKString  getStartedLast();

setStartedLast
Sets the timestamp of the last indexing start time.
    void setStartedLast(const char* time);

getEndedLast
Returns the timestamp of the last indexing end time.
 DKString getEndedLast();

setEndedLast
Sets the timestamp of the last indexing end time.
    void setEndedLast(const char* time);

getStartedExecution
Returns the timestamp of the indexing execution start time.
 DKString getStartedExecution();

setStartedExecution
Sets the timestamp of the indexing execution start time.
    void setStartedExecution(const char* time);

getScheduledDocs
Gets the number of indexing requests that are currently scheduled.
      long getScheduledDocs();
 

setScheduledDocs
Sets the number of scheduled indexing requests. This function is only used to get information into the class; this function will not update the datastore.
      void setScheduledDocs(long scheduledDocs);
 

getDocsInPrimaryIndex
Gets the number of documents in the primary index.
      long getDocsInPrimaryIndex();
 

setDocsInPrimaryIndex
Sets the number of documents in the primary index. This function is only used to get information into the class; this function will not update the datastore.
      void setDocsInPrimaryIndex(long primaryDocs);
 

getDocsInSecondaryIndex
Gets the number of documents in the secondary index.
      long getDocsInSecondaryIndex();
 

setDocsInSecondaryIndex
Sets the number of documents in the secondary index. This function is only used to get information into the class; this function will not update the datastore.
      void setDocsInSecondaryIndex(long secondaryDocs);
 

getDocMessages
Gets the number of document messages written during indexing.
      long getDocMessages();
 

setDocMessages
Sets the number of documents messages written during indexing. This function is only used to get information into the class; this function will not update the datastore.
      void setDocMessages(long docMsgs);
 

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