Purpose:
This class can be used to access a Domino.Doc datastore, which is called a "library". Documents are the smallest entity stored in a Domino.Doc library. A Domino.Doc library has entities which have sub entities: A library has "rooms," which have "cabinets," which have "binders," which have "documents."
Class summary:
class DKDatastoreDD : public dkDatastore { public: DKDatastoreDD(); DKDatastoreDD(const char* configuration); virtual ~DKDatastoreDD(); virtual void connect( const char* datastore_name , const char* user_name = "" , const char* authentication = "" , const char* connect_string = ""); virtual void disconnect(); virtual dkExtension* getExtension(const char* extensionName); virtual void addExtension(const char* extensionName, dkExtension* extensionObj); virtual void removeExtension(const char* extensionName); virtual DKString* listExtensionNames(long& arraySize); virtual dkCollection* listEntities(); virtual dkCollection* listSearchableEntities(); virtual DKString* listSearchableEntityNames(long& arraySize); virtual DKBoolean isConnected(); virtual DKString getLibraryName(); virtual DKHandle* handle(const char* type); virtual void retrieveObject(dkDataObject* dataobj); virtual dkDatastoreDef* datastoreDef(); virtual void getOption(long option, DKAny& value); virtual void setOption(long option, DKAny& value); virtual DKString registerMapping(DKNVPair* sourceMap); virtual void unRegisterMapping(const char* mappingName); virtual DKString* listMappingNames(long& arraySize); virtual dkSchemaMapping* getMapping(const char* mappingName); virtual DKAny evaluate(const char* command, const short commandLangType, const DKNVPair* parms = 0); virtual DKAny evaluate( dkQuery* query); virtual DKAny evaluate(DKCQExpr* qe); virtual dkResultSetCursor* execute( const char* command, const short commandLangType, const DKNVPair* parms = 0); virtual dkResultSetCursor* execute( dkQuery* query); virtual dkResultSetCursor* execute( DKCQExpr* qe); virtual void executeWithCallback( const char* command, const short commandLangType, const DKNVPair* parms, dkCallback* callbackObj); virtual void executeWithCallback( dkQuery* query, dkCallback* callbackObj); virtual void executeWithCallback( DKCQExpr* qe, dkCallback* callbackObj); virtual dkQuery* createQuery(const char* command, const short commandLangType, const DKNVPair* parms=0); virtual dkQuery* createQuery(DKCQExpr* qe); };
Members:
DKDatastoreDD(); DKDatastoreDD(const char* configuration); virtual ~DKDatastoreDD();
Parameters
virtual void connect( const char* datastore_name , const char* user_name = "" , const char* authentication = "" , const char* connect_string = "");
virtual void disconnect();
virtual dkExtension* getExtension(const char* extensionName);
virtual void addExtension(const char* extensionName, dkExtension* extensionObj);
virtual void removeExtension(const char* extensionName);
virtual DKString* listExtensionNames(long& arraySize);
virtual dkCollection* listEntities();
virtual dkCollection* listSearchableEntities();
virtual DKString* listSearchableEntityNames(long& arraySize);
virtual DKBoolean isConnected();
virtual DKString getLibraryName();
virtual DKHandle* handle(const char* type);
virtual void retrieveObject(dkDataObject* dataobj);
virtual dkDatastoreDef* datastoreDef();
virtual void getOption(long option, DKAny& value);
virtual void setOption(long option, DKAny& value);
virtual DKString registerMapping(DKNVPair* sourceMap);
virtual void unRegisterMapping(const char* mappingName);
virtual DKString* listMappingNames(long& arraySize);
virtual dkSchemaMapping* getMapping(const char* mappingName);
Parameters
"ENTITY=<"cabinetTitle">; QUERY=<"lotusQueryString">"
virtual DKAny evaluate(const char* command, const short commandLangType, const DKNVPair* parms = 0); virtual DKAny evaluate( dkQuery* query); virtual DKAny evaluate(DKCQExpr* qe);
virtual dkResultSetCursor* execute( const char* command, const short commandLangType, const DKNVPair* parms = 0); virtual dkResultSetCursor* execute( dkQuery* query); virtual dkResultSetCursor* execute( DKCQExpr* qe);
virtual void executeWithCallback( const char* command, const short commandLangType, const DKNVPair* parms, dkCallback* callbackObj); virtual void executeWithCallback( dkQuery* query, dkCallback* callbackObj); virtual void executeWithCallback( DKCQExpr* qe, dkCallback* callbackObj);
virtual dkQuery* createQuery(DKCQExpr* qe);
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.