Purpose:
This class is used to specify the definition for a user group in Content Manager Version 8.
Since: Version 8
Hierarchy: dkUserGroupDef DKUserGroupDefICM
Class summary:
class DKUserGroupDefICM : public dkUserGroupDef { public: DKUserGroupDefICM(); DKUserGroupDefICM(dkDatastore* ds); DKUserGroupDefICM(const char* userGrpName); virtual ~DKUserGroupDefICM(); virtual dkCollection* listUsers(); virtual DKString* listUserNames(long& arraySize); virtual void addUser(dkUserDef* userDefObj); virtual void removeUser(const char* userName); virtual void clearCache(); DKString getNewName(); void setNewName(const char* name); void setRetrieved(DKBoolean isRetrieved); DKString getDomainName(); void setDomainName(const char* name); long getDomainId(); void setDomainId(long id); DKBoolean isNameChanged(); DKString getOldName(); void setUsers(dkCollection* dkColl); dkCollection* getUsers(); };
Members:
DKUserGroupDefICM()
Default constructor. Creates a user group definition that is not associated with any datastore instance currently.
DKUserGroupDefICM(dkDatastore* ds)
Constructor that takes a datastore instance as a parameter. The returned user group definition instance is associated with the datastore instance. Equivalent to calling the default constructor followed by the setDatastore method on the created object.
Parameters:ds - valid instance of a datastore object, which should be an instance of
DKUserGroupDefICM(const char* userGrpName)
Constructs and initializes a user group class associated with a specified user group name.
Parameters:userGrpName - string - name of a user group. It can be up to 32 characters long.
virtual ~DKUserGroupDefICM()
Returns:Collection of user definitions as instances of DKUserDefICM
virtual dkCollection* listUsers();
Parameters:arraySize - size of the returned array
Returns:array of user names as DKString variable instances
Throws:DKException if error occurs on the server
virtual DKString* listUsernames(long& arraySize);
virtual void clearCache();
Parameters:userName - name of user to be removed
virtual void removeUser(const char* userName);
Parameters:userDefObj - user definition object as an instance of DKUserDefICM
virtual void addUser(dkUserDef* userDefObj);
Returns:New or original name as a DKString variable
DKString getNewName();
Parameters:name - new name for the user group
void setNewName(const char* name);
Returns:Name of the administration domain as a DKString variable
DKString getDomainName();
Parameters:name - new name of the administration domain
void setDomainName(const char* name);
Returns:ID of the administration domain
long getDomainId();
void setDomainId(long id);
Parameters:isRetrieved - if TRUE, the user group is determined to have been retrieved; if FALSE, the user group is determined not to have been retrieved.
void setRetrieved(DKBoolean isRetrieved);
Returns:TRUE if the name was changed; FALSE otherwise.
DKBoolean isNameChanged();
Returns:Old name of the user group if the name was changed; Blank string returned otherwise.
DKString getOldName();
Returns:Collection of user definitions as instances of DKUserDefICM
dkCollection* getUsers();
Parameters:dkColl - collection of user definitions as instances of DKUserDefICM
void setUsers(dkCollection* dkColl);
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.