Purpose:
DKFolderOD is the base interface for datastore specific search template classes.
Class summary:
class DKEXPORT DKFolderOD : public dkSearchTemplate { public: DKFolderOD(DKDatastoreOD* ds, DKString name, DKString desc, void* pSession); ~DKFolderOD(); DKString name(); DKString getName(); void setName(const char* newName); DKString getDescription(); void setDescription(const char* desc); short getId(); void setId(short id); DKString getEntityName(); void setEntityName(const char* entityName); dkDatastore* getDatastore(); void setDatastore(DKDatastoreOD* ds); void add(); void del(); void update(); void retrieve(); void add(DKSearchCriteria* newCrit); void del(const char* name); void update(DKSearchCriteria* crit); DKSearchCriteria* retrieve(const char* critName); void addCriteria(DKSearchCriteria* newCrit); void removeCriteria(const char* critName); void updateCriteria(DKSearchCriteria* crit); DKSearchCriteria* getCriteria(const char* critName); dkCollection* listCriteria(); DKString* listCriteriaNames(long& arraySize); DKString* listDisplayNames(long& arraySize); DKString* listSearchableCriteriaNames(long& arraySize); void setParametricOp(short allOp); short getParametricOp(); long* getSortOrders(long& arraySize); void setSortOrders(long* sortOrders, long arraySize); void addUser(const char* userName, short access); void addGroup(const char* groupName, short access); void removeUser(const char* userName); void removeGroup(const char* groupName); DKString* listUsers(long& arraySize); DKString* listGroups(long& arraySize); DKCQExpr* createQueryExpr(); DKSearchCriteria* getCriteria(long critNum); DKSearchCriteria* getQueryCriteria(long queryCritNum); long getNumFields(); long getNumCrit(); void setNumCrit(long num); long getNumQueryCrit(); void setNumQueryCrit(long num); long* getQueryOrder(); long getNumDisplayCrit(); void setNumDisplayCrit(long num); long* getDisplayOrder(); long getNumSortCrit(); void setNumSortCrit(long num); DKSearchCriteria** getCritInfo(); void setCritInfo(DKSearchCriteria** critInfo, int numCrit); DKString critName(short fldId); PFieldStructOD* getFieldInfo(long& arraySize); dkAttrDef* createAttr(); dkAttrDef* getAttr(DKString attrName); dkCollection* listAttrs(); DKString* listAttrNames(long& arraySize); void clearCache(); };
Members:
DKString getName();
void setName(const char* name);
SDKString getDescription();
void setDescription(const char* desc);
short getId();
void setId(short id);
DKString getEntityName();
void setEntityName(const char* newName);
dkDatastore* getDatastore();
void setDatastore(dkDatastore* ds);
void add(); void add(DKSearchCriteria* newCriteria);
void del(); void del(const char* criteriaName);
void update(); void update(DKSearchCriteria* criteria);
void retrieve(); DKSearchCriteria* retrieve(const char* critName);
void addCriteria(DKSearchCriteria* newCriteria);
void removeCriteria(const char* critName);
void updateCriteria(DKSearchCriteria* criteria);
DKSearchCriteria* getCriteria(const char* criteriaName); DKSearchCriteria* getCriteria(long critNum);
DKSearchCriteria* getQueryCriteria(long queryCritNum);
dkCollection* listCriteria();
DKString* listCriteriaNames(long& arraySize);
DKString* listDisplayNames(long& arraySize);
long* getSortOrders(long& arraySize);
void setSortOrders(long* sortOrders, long arraySize);
void addUser(const char* userName, short access);
void addGroup(const char* groupName, short access);
void removeUser(const char* userName);
void removeGroup(const char* groupName);
DKString* listUsers(long& arraySize);
DKString* listGroups(long& arraySize);
DKCQExpr* createQueryExpr();
long getNumFields();
long getNumCrit();
void setNumCrit(long num);
long getNumCrit();
void setNumCrit(long num);
long getNumQueryCrit();
void setNumQueryCrit(long num);
long* getQueryOrder();
long getNumDisplayCrit();
void setNumDisplayCrit(long num);
long* getDisplayOrder();
long getNumSortCrit();
void setNumSortCrit(long num);
DKSearchCriteria** getCritInfo();
void setCritInfo(DKSearchCriteria** critInfo, int numCrit);
DKString critName(short fldId);
PFieldStructOD* getFieldInfo(long& arraySize);
dkAttrDef* createAttr();
dkAttrDef* getAttr(DKString attrName);
dkCollection* listAttrs();
vDKString* listAttrNames(long& arraySize);
void clearCache();
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.