Purpose:
DKSearchTemplateFed is a federated datastore search template definition class.
Heirarchy:
DKSearchTemplate DKSearchTemplateFed
Class summary:
class DKSearchTemplateFed : public dkSearchTemplate { public: DKSearchTemplateFed(); DKSearchTemplateFed(dkDatastore* ds); virtual ~DKSearchTemplateFed(); virtual void add(); virtual void del(); virtual void update(); virtual void retrieve(); virtual void add(DKSearchCriteria* newCriteria); virtual void del(const char* criteriaName); virtual void update(DKSearchCriteria* criteria); virtual DKSearchCriteria* retrieve(const char* criteriaName); virtual void addCriteria(DKSearchCriteria* newCriteria); virtual void removeCriteria(const char* criteriaName); virtual void updateCriteria(DKSearchCriteria* criteria); virtual DKSearchCriteria* getCriteria(const char* criteriaName); virtual dkCollection* listCriteria(); virtual DKString* listCriteriaNames(long& arraySize); virtual DKString* listTextCriteriaNames(long& arraySize); virtual DKString* listParmCriteriaNames(long& arraySize); virtual DKString* listQBICCriteriaNames(long& arraySize); virtual DKString* listAttrDisplayNames(long& arraySize); virtual DKString* listAllAttrDisplayNames(long& arraySize); virtual DKString* listDisplayNames(long& arraySize); virtual DKString* listSearchableCriteriaNames(long& arraySize); virtual void setParametricOp(short allOp); virtual short getParametricOp(); virtual long* getSortOrders(long& arraySize); virtual void setSortOrders(long* sortOrders, long arraySize); virtual void addUser(const char* userName, short access); virtual void addGroup(const char* groupName, short access); virtual void removeUser(const char* userName); virtual void removeGroup(const char* groupName); virtual DKString* listUsers(long& arraySize); virtual DKString* listGroups(long& arraySize); virtual DKCQExpr* createQueryExpr(); virtual DKCQExpr** createQueryExpr(const char* serverName, long& arraySize); virtual DKString getAssocFedEntity(const char* fedTextEntityName); virtual DKString getAssocFedTextEntity(const char* fedParmEntityName); DKString getFolderName(); void setFolderName(const char* folderName); short getServerParticipation(); // return _serverControl void setServerParticipation(short serverP); short getGlobalOp(); void setGlobalOp(short op); DKString getTextSingleCharWildcard(); void setTextSingleCharWildcard(const char* wildcard); DKString getTextMultiCharWildcard(); void setTextMultiCharWildcard(const char* wildcard); DKString getParmWildcard(); void setParmWildcard(const char* wildcard); long optionCount(); DKNVPair* getOptionList(long& arraySize); void setOptionList(const DKNVPair* optionList, long arraySize); DKNVPair* getOption(long position); DKNVPair* getOption(const char* name); void setOption(long position, const DKNVPair& optionPair); long setOption(const char* name, const DKAny& value); void removeOption(long position); void removeOption(const char* name); };
Members:
DKSearchTemplateFed(); DKSearchTemplateFed(dkDatastore* ds); virtual ~DKSearchTemplateFed();
virtual void add(); virtual void add(DKSearchCriteria* newCriteria);
virtual void del(); virtual void del(const char* criteriaName);
virtual void update(); virtual void update(DKSearchCriteria* criteria);
virtual void retrieve(); virtual DKSearchCriteria* retrieve(const char* criteriaName);
virtual void addCriteria(DKSearchCriteria* newCriteria);
virtual void removeCriteria(const char* criteriaName);
virtual void updateCriteria(DKSearchCriteria* criteria);
virtual DKSearchCriteria* getCriteria(const char* criteriaName);
virtual dkCollection* listCriteria();
virtual DKString* listCriteriaNames(long& arraySize);
virtual DKString* listTextCriteriaNames(long& arraySize);
virtual DKString* listParmCriteriaNames(long& arraySize);
virtual DKString* listQBICCriteriaNames(long& arraySize);
virtual DKString* listAttrDisplayNames(long& arraySize);
virtual DKString* listAllAttrDisplayNames(long& arraySize);
virtual DKString* listDisplayNames(long& arraySize);
virtual DKString* listSearchableCriteriaNames(long& arraySize);
Parameters
virtual void setParametricOp(short allOp);
virtual short getParametricOp();
virtual long* getSortOrders(long& arraySize);
virtual void setSortOrders(long* sortOrders, long arraySize);
virtual void addUser(const char* userName, short access);
virtual void addGroup(const char* groupName, short access);
virtual void removeUser(const char* userName);
virtual void removeGroup(const char* groupName);
virtual DKString* listUsers(long& arraySize);
virtual DKString* listGroups(long& arraySize);
virtual DKCQExpr* createQueryExpr(); virtual DKCQExpr** createQueryExpr(const char* serverName, long& arraySize);
virtual DKString getAssocFedEntity(const char* fedTextEntityName);
virtual DKString getAssocFedTextEntity(const char* fedParmEntityName);
DKString getFolderName();
void setFolderName(const char* folderName);
short getServerParticipation();
void setServerParticipation(short serverP);
DKString getTextSingleCharWildcard();
void setTextSingleCharWildcard(const char* wildcard);
DKString getTextMultiCharWildcard();
void setTextMultiCharWildcard(const char* wildcard);
DKString getParmWildcard();
void setParmWildcard(const char* wildcard);
long optionCount();
DKNVPair* getOptionList(long& arraySize);
void setOptionList(const DKNVPair* optionList, long arraySize);
DKNVPair* getOption(long position); DKNVPair* getOption(const char* name);
void setOption(long position, const DKNVPair& optionPair); long setOption(const char* name, const DKAny& value);
void removeOption(long position); void removeOption(const char* name);
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.