Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkUserDef

All Known Implementing Classes:
dkAbstractUserDef

public interface dkUserDef

dkUserDef : This class represents a user definition.


Method Summary
 void changePassword(java.lang.String oldPwd, java.lang.String newPwd)
          Changes the password of a given user
 java.lang.String datastoreType()
          Gets datastore type
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getDescription()
          Get the description of this user
 java.lang.String getFullName()
          Gets user full name
 java.lang.String getName()
          Gets user name
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setDescription(java.lang.String desc)
          Sets description of this user
 void setFullName(java.lang.String fullName)
          Sets user full name
 void setName(java.lang.String name)
          Sets user name
 void setPassword(java.lang.String authentication)
          Sets user password
 

Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Parameters:
ds - datastore

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Returns:
the dkDatastore object

getName

public java.lang.String getName()
Gets user name
Returns:
name of this user

setName

public void setName(java.lang.String name)
Sets user name
Parameters:
name - name of this user object

datastoreType

public java.lang.String datastoreType()
                               throws java.lang.Exception
Gets datastore type
Returns:
name of type of datastore this user belongs to

getDescription

public java.lang.String getDescription()
Get the description of this user
Returns:
string containing description.

setDescription

public void setDescription(java.lang.String desc)
Sets description of this user
Parameters:
desc - description about this user

getFullName

public java.lang.String getFullName()
Gets user full name
Returns:
full name of this user

setFullName

public void setFullName(java.lang.String fullName)
Sets user full name
Parameters:
fullName - full name of this user object

setPassword

public void setPassword(java.lang.String authentication)
Sets user password
Parameters:
authentication - password of this user object

changePassword

public void changePassword(java.lang.String oldPwd,
                           java.lang.String newPwd)
                    throws DKException,
                           java.lang.Exception
Changes the password of a given user

Note:DKUsageError exception thrown if method is not implemented


EIP Java APIs

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