Index

DKFolderOD

Purpose:

DKFolderOD is the base interface for datastore specific search template classes.

Heirarchy:
dkSearchTemplate DKFolderOD

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:

Member functions

getName
Gets the search template name.
   DKString  getName();
 

setName
Sets the name of this extension object.
 void setName(const char* name);
 

getDescription
Gets the description of this search template.
  SDKString getDescription();   
 

setDescription
Sets the description for this search template.
   void  setDescription(const char* desc);
 

getId
Gets the search template ID.
 short getId(); 

setId
Sets the search template ID.
  void setId(short id); 

getEntityName
Sets the search template ID.
  DKString getEntityName();
 

setEntityName
Sets the search template ID.
  void setEntityName(const char* newName); 

getDatastore
Gets the reference to the owner datastore object.
  dkDatastore* getDatastore(); 

setDatastore
Sets the reference to the owner datastore object. .
  void  setDatastore(dkDatastore* ds); 

add
These functions are not supported.
  void add();
void add(DKSearchCriteria* newCriteria);
 

del
These functions are not supported.
  void  del();
void  del(const char* criteriaName); 

update
These functions are not supported.
  void update();
void update(DKSearchCriteria* criteria);

retrieve
These functions are not supported.
  void              retrieve();
DKSearchCriteria* retrieve(const char* critName);
 

addCriteria
Adds a new search criteria to this OnDemand folder definition in-memory.
  void  addCriteria(DKSearchCriteria* newCriteria);
 

removeCriteria
This functions is not supported.
  void removeCriteria(const char* critName); 

updateCriteria
This functions is not supported.
  void updateCriteria(DKSearchCriteria* criteria);

getCriteria
The first form retrieves a search criteria with the given name. the second form retrieves a search criteria with the given number.
  DKSearchCriteria* getCriteria(const char* criteriaName);
 
DKSearchCriteria* getCriteria(long critNum);
 

getQueryCriteria
Retrieves a query criteria with the given number.
  DKSearchCriteria* getQueryCriteria(long queryCritNum);

listCriteria
Gets a list of search criteria in this search template.
  dkCollection*  listCriteria();
 

listCriteriaNames
Gets a list of search criteria names in this search template.
  DKString* listCriteriaNames(long& arraySize);
 

listDisplayNames
Gets a list of search results display names.
 DKString* listDisplayNames(long& arraySize);

setParametericOp
Sets the operator between search criteria. The default is DK_CM_OP_ALL_ANDS.
  

Parameters

allOp
One the following values: DK_CM_OP_ALL_ANDS DK_CM_OP_ALL_ORS DK_CM_OP_ALL_MIXED void setParametricOp(short allOp);

getSortOrders
Gets the list of attribute sorting orders. This function is called by the server only.
  long* getSortOrders(long& arraySize);
 

setSortOrders
Sets the list of attribute sorting orders.
  void setSortOrders(long* sortOrders, long arraySize);
 

addUser
This functions is not supported.
  void addUser(const char* userName, short access);
 

addGroup
This functions is not supported.
  void addGroup(const char* groupName, short access);
 

removeUser
This functions is not supported.
  void removeUser(const char* userName); 

removeGroup
This functions is not supported.
  void removeGroup(const char* groupName); 

listUsers
This functions is not supported.
  DKString* listUsers(long& arraySize); 

listGroups
This functions is not supported.
  DKString* listGroups(long& arraySize); 

createQueryExp
This functions is not supported.
 DKCQExpr* createQueryExpr();
 
 

getNumFields
This functions is not supported.
  long getNumFields(); 

getNumCrit
Gets the number of the criteria defined.
 long getNumCrit(); 

setNumCrit
This function is not supported.
  void setNumCrit(long num);
 

getNumQueryCrit
Gets the number of the criteria defined.
  long getNumCrit(); 

setNumCrit
This functions is not supported.
  void setNumCrit(long num); 

getNumQueryCrit
Gets the number of the queryable criteria defined.
  long getNumQueryCrit();
 

setNumQueryCrit
This functions is not supported.
  void setNumQueryCrit(long num); 

getQueryOrder
Gets the order list of the queryable criteria.
  long* getQueryOrder(); 

getNumDisplayCrit
Gets the number of the displayable criteria defined.
  long getNumDisplayCrit(); 

setNumDisplayCrit
This function is not supported.
  void setNumDisplayCrit(long num); 

getDisplayOrder
Gets the order list of the displayable criteria.
  long* getDisplayOrder(); 

getNumSortCrit
This functions is not supported.
  long getNumSortCrit(); 

setNumSortCrit
This functions is not supported.
  void setNumSortCrit(long num); 

getCritInfo
Gets the search criteria defined for this folder.
  DKSearchCriteria** getCritInfo(); 

setCritInfo
Sets the search criteria for this folder.
  void setCritInfo(DKSearchCriteria** critInfo, int numCrit);
 
 

critName
Gets a criteria name by it field ID.
  DKString critName(short fldId); 

getFieldInfo
Gets the field information.
  PFieldStructOD* getFieldInfo(long& arraySize); 

createAttr
Create a dkAttrDef object for this datastore.
  dkAttrDef* createAttr(); 

getAttr
Gets attribute definition by the attribute name. .
  dkAttrDef* getAttr(DKString attrName);
 

listAttrs
List all attributes for this entity.
  dkCollection* listAttrs(); 

listAttrNames
List all attribute names for this entity.
  vDKString* listAttrNames(long& arraySize);
 

clearCache
This functions is not supported.
  void clearCache();

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