Index

DKUserDefICM

Purpose:

This class is used to specify the definition for a user in Content Manager Version 8.

Since: Version 8

Hierarchy:

dkUserDef

DKUserDefICM

Class summary:

class DKUserDefICM : public dkUserDef
 {
   public:
 
     DKUserDefICM();
     DKUserDefICM(dkDatastore* ds);
     virtual ~DKUserDefICM();
  
     DKString getUserPWD();
     void setUserPWD(const char* pwd);
     DKString getPrivSetName();
     void setPrivSetName(const char* privSetName);
     void setPrivSetCode(long code);
     long getPrivSetCode();
     void setPrivSetDesc(const char* privSetDesc);
     DKString getPrivSetDesc();
     DKString getGrantPrivSetName();
     void setGrantPrivSetName(const char* name);
     DKString getDflItemACLName();
     void setDflItemACLName(const char* name);
     long getGrantPrivSetCode();
     void setGrantPrivSetCode(long code);
     short getObjServerCode();
     void setObjServerCode(short code);
     short getCollCode();
     void setCollCode(short code);
     DKString getObjServerName();
     void setObjServerName(const char* name);
     DKString getCollName();
     void setCollName(const char* name);
     DKString getDomainName();
     void setDomainName(const char* name);
     long getDomainId();
     void setDomainId(long id);
     long getDflItemACLCode();
     void setDflItemACLCode(long code);
     DKString getUserDN();
     void setUserDN(const char* str);
     long getPwdExpire();
     void setPwdExpire(long expire);
     DKBoolean isSysPswd();
     void setSysPswd(DKBoolean b);

Members:

Constructors and destructor
DKUserDefICM()

Default constructor. Creates a user definition that is not associated with any datastore instance currently.

DKUserDefICM(dkDatastore* ds)

Constructor that takes a datastore instance as a parameter. The returned user 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. Should be an instance of DKDatastoreICM.

virtual ~DKUserDefICM()

Destructor for this object.

Member functions

getUserPWD()
Retrieves the password for the user represented by the user definition object.

Returns:Password as an instance of a DKString variable.

DKString getUserPWD(); 

setUserPWD()
Sets the user password for the user represented by the user definition object.

Parameters:pwd - password as a DKString instance

void setUserPWD(const char* pwd);

getPrivSetName()
Retrieves the privilege set name for the user represented by the user definition object.

Returns:privilege set name as an instance of a DKString variable.

DKString getPrivSetName();

setPrivSetName()
Sets the privilege set name for the user represented by the user definition object.

Parameters:privSetname - privilege set name as a DKString variable

void setPrivSetName(const char* privSetName);

getPrivSetCode()
Retrieves the code for the privilege set to be associated with the user specified by the user definition object.

Returns:privilege set code

long getPrivSetCode(); 

setPrivSetCode()
Sets the code of the privilege set to be associated with the user specified by the user definition object.

Parameters:code - privilege set code

void setPrivSetCode(long code);

getPrivSetDesc()
Retrieves the privilege set description for the privilege set to be associated with the user specified by the user definition object.

Returns:Privilege set description as instance of DKString variable.

DKString getPrivSetDesc(); 

setPrivSetDesc()
Sets the description of the privilege set associated with the user specified by the user definition object.

Parameters:privSetDesc - privilege set description

void setPrivSetDesc(const char* privSetDesc); 

getGrantPrivSetName()
Retrieves the name of the grant privilege set to be associated with the user specified by the user definition object.

Returns:grant privilege set name as a DKString variable.

DKString getGrantPrivSetName(); 

setGrantPrivSetName()
Sets the name of the grant privilege set to be associated with the user specified by the user definition object.

Parameters:name - name of the grant privilege set as a DKString variable.

void setGrantPrivSetName(const char* name);

getGrantPrivSetCode()
Retrieves the code for the grant privilege set associated with the user specified by the user definition object.

Returns:grant privilege code

long getGrantPrivSetCode();

setGrantPrivSetCode()
Sets the code for the grant privilege set associated with the user specified by the user definition object.

Parameters:code - grant privilege set code

void setGrantPrivSetCode(long code);

getDflItemACLName()
Retrieves the default item ACL name associated with the user specified by this user definition object.

Returns:name of default item ACL as a DKString variable

DKString getDflItemACLName(); 

setDflItemACLName()
Sets the default item ACL name associated with the user specified by this user definition object.

Parameters:name - default item ACL name to be set

void setDflItemACLName(const char* name);

getCollCode()
Retrieves the SMS collection code for the user specified by this user definition object.

Returns:SMS Collection code

short getCollCode();

setCollCode()
Sets the SMS collection code for the user specified by this user definition object.

Parameters:code - SMS collection code to be set

void setCollCode(short code);

getCollName()
Retrieves the default SMS collection name for the user specified by this user definition object.

Returns:default SMS Collection name as a DKString variable

DKString getCollName();

setCollName()
Sets the default SMS collection name associated with the user specified by this user definition object.

Parameters:name - name of the default SMS collection as a DKString variable

void setCollName(const char* name);

getObjServerCode()
Retrieves the code for the resource manager associated with the user specified by this user definition object.

Returns:resource manager code

short getObjServerCode();

setObjServerCode()
Sets the code for the resource manager associated with the user specified by this user definition object.

Parameters:code - resource manager code

void setObjServerCode (short code);

getObjServerName()
Retrieves the name of the resource manager associated with the user specified by this user definition object.

Returns:resource manager name as a DKString variable

DKString getObjServerName();

setObjServerName()
Sets the name of the resource manager associated with the user specified by this user definition object.

Parameters:name - name of the resource manager

void setObjServerName(const char* name);

getDomainName()
Retrieves the name of the administration domain associated with the user specified by this user definition object.

Returns:domain name as a DKString variable

DKString getDomainName();

setDomainName()
Sets the name of the administration domain associated with the user specified by this user definition object.

Parameters:name - name of the administration domain

void setDomainName(const char* name);

getDomainId()
Retrieves the ID of the adminstration domain associated with the user specified by this user definition object.

Returns:ID of the administration domain

long getDomainId();

setDomainId()
Sets the ID of the adminstration domain associated with the user specified by this user definition object.

Parameters:ID - ID of the administration domain

void setDomainID(long id);

getUserDN()
Retrieves the distinguished name for the user specified by this user definition object.

Returns:distinguished name as a DKString variable

DKString getUserDN();

setUserDN()
Sets the distinguished name of the user specified by this user definition object.

Parameters:str - distinguished name

void setUserDN(const char* str);

getPwdExpire()
Retrieves password expiration time for the user specified by the user definition object.

Returns:password expiration time in number of days

long getPwdExpire();

setPwdExpire()
Sets the password expiration time for the user specified by the user definition object.

Parameters:expire - password expiration time in number of days

void setPwdExpire(long expire);

isSysPswd()
Checks to see if the user specified by this user definition object uses the system password or not.

Returns:TRUE if the user uses the system password; FALSE otherwise

DKBoolean isSysPswd();

setSysPswd()
Sets whether the user specified by this user definition object uses the system password or not.

Parameters:b -if TRUE, the user can use the system password; if FALSE, the user cannot use the system password

void setSysPswd(DKBoolean b);

getDflItemACLCode()
Retrieves the default item ACL ID associated with the user specified by this user definition object.

Returns:default item ACL code

long getDflItemACLCode();

setDflItemACLCode()
Sets the default item ACL ID associated with the user specified by this user definition object.

Parameters:code - default item ACL code to be set

void setDflItemACLCode(long code);

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