Index

dkUserGroupDef

Purpose:

The dkUserGroupDef provides a generic interface to user group definition object functions. It must be subclassed for each datastore implementation, for example:

DKUserGroupDefICM and so forth. 

Class summary:

class DKEXPORT dkUserGroupDef
 {
   public:
    dkUserGroupDef();
    virtual ~dkUserGroupDef(); 
 
    virtual void setDatastore(dkDatastore* ds);
    virtual dkDatastore* getDatastore();
    virtual void setName(const char* name);
    virtual DKString getName();
    virtual DKString datastoreType();
    virtual void setDescription(const char* desc);
    virtual DKString getDescription();
    virtual dkCollection* listUsers();
    virtual DKString* listUserNames(long& arraySize);
    virtual void addUser(dkUserDef* userDefObj);
    virtual void removeUser(const char* userName);
    virtual void clearCache();
 };

Members:

Constructors and destructor
  
           dkUserGroupDef();
           virtual ~dkUserGroupDef(); 

Member functions

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

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

datastoreType
Gets the datastore type.
virtual DKString datastoreType(); 

getName
Gets the name of this user group.
virtual DKString  getName(); 

setName
Sets the name for this user group.
virtual void setName(const char* name); 

getDescription
Gets the description of this user group.
virtual DKString getDescription(); 

setDescription
Sets the description of this user group.
virtual void setDescription(const char* description);

listUsers
Gets a list of user defined to the user group.
virtual dkCollection* listUsers();

Note:
DKUsageError exception thrown if function is not implemented.

listUserNames
Gets a list of user names defined to the user group.
virtual DKString* listUserNames(long& arraySize);

Note:
DKUsageError exception thrown if function is not implemented.

addUser
Adds the given user object to the group memory only.
virtual void addUser(dkUserDef* userDefObj);

removeUser
Deletes the given user object from the group memory only.
virtual void removeUser(const char* userName);

Note:
DKUsageError exception thrown if function is not implemented.

clearCache
Clear user group cache.
virtual void clearCache();

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