Index

DKDatastoreAdminTS

Purpose:

This is the class that is used to represent a datastore administration for text search.

Class summary:

class DKDatastoreAdminTS : public dkDatastoreAdmin
 {
   public:
    virtual ~DKDatastoreAdminTS();
    virtual dkDatastore* getDatastore();
    virtual void setDatastore(dkDatastore* ds);
    virtual void startUpdateIndex(const char* indexName);
    virtual void clearIndex(const char* indexName);
    virtual DKIndexFuncStatusTS* getIndexFunctionStatus(const char* indexName,
                                                        long funcId);
    virtual void setIndexFunctionStatus(const char* indexName, long funcId,
                                        long actionId);
    virtual void reorgIndex(const char* indexName);
    virtual void clearScheduledDocuments(const char* indexName);
    virtual DKIndexingRulesTS* getIndexingRules(const char* indexName);
    virtual void setIndexingRules(DKIndexingRulesTS* indexRules);
    virtual dkCollection* getIndexingDocMessages(const char* indexName);
    virtual void  deleteIndexingDocMessages(const char* indexName);
    virtual void createDocModel(const char* indexName,
                                DKDocModelTS* docModel);
    virtual void deleteDocModel(const char* indexName,
                                long ccsid, const char* docModelName);
    virtual DKDocModelTS* getDocModel(const char* indexName,
                         long ccsid, const char* docModelName);
    virtual dkCollection* listDocModels(const char* indexName);
 }

Members:

Constructors and destructor
virtual ~DKDatastoreAdminTS(); 

Member functions

getDatastore
Gets the datastore.
virtual dkDatastore* getDatastore(); 

setDatastore
Sets the datastore.
virtual void setDatastore(dkDatastore* ds);

startUpdateIndex
Starts the indexing process.
virtual void startUpdateIndex(const char* indexName);

clearIndex
Clears the index. Note: You should clear the index before deleting the search index.
virtual void clearIndex(const char* indexName);

getIndexFunctionStatus
getIndexFunctionStatus has been deprecated and replaced with getIndexFunctionStatus in the DKDatastoreAdminTS class.
virtual DKIndexFuncStatusTS* getIndexFunctionStatus(const char* indexName); 

setIndexFunctionStatus
setIndexFunctionStatus has been deprecated and replaced with setIndexFunctionStatus in the DKDatastoreAdminTS class.
void setIndexFunctionStatus(const char* indexName, long actionId); 

reorgIndex
Reorganizes the index.
virtual void reorgIndex(const char* indexName);

clearScheduleDocuments
Clears scheduled documents.
virtual void clearScheduledDocuments(const char* indexName);

getIndexingRules
Gets indexing rules.
virtual DKIndexingRulesTS* getIndexingRules(const char* indexName);

setIndexingRules
Sets indexing rules.
virtual void setIndexingRules(DKIndexingRulesTS*   indexRules);

getIndexingDocMessages
Gets indexing document messages.
virtual dkCollection* getIndexingDocMessages(const char* indexName);

deleteIndexingDocMessages
Deletes indexing document messages.
virtual void  deleteIndexingDocMessages(const char* indexName);

createDocModel
Creates a document model.
virtual void createDocModel(const char* indexName,
DKDocModelTS* docModel);

deleteDocModel
Deletes a document model.
virtual void deleteDocModel(const char* indexName,
long ccsid, const char* docModelName); 

getDocModel
Gets a document model.
virtual DKDocModelTS* getDocModel(const char* indexName,
long ccsid, const char* docModelName); 

listDocModels
Lists document models.
virtual dkCollection* listDocModels(const char* indexName); 

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