Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractUserDef

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractUserDef
All Implemented Interfaces:
DKMessageId, dkUserDef, java.io.Serializable
Direct Known Subclasses:
DKUserDataFed, DKUserDefICM

public abstract class dkAbstractUserDef
extends java.lang.Object
implements dkUserDef, DKMessageId, java.io.Serializable

This class defines methods to access user information

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkAbstractUserDef()
          Constructs a new dkAbstractUserDef class without owner datastore object.
dkAbstractUserDef(dkDatastore ds)
          Constructs a new dkAbstractUserDef class with owner datastore object
 
Method Summary
 void changePassword(java.lang.String oldPwd, java.lang.String newPwd)
          Changes the password of a given user
 java.lang.String datastoreType()
          Gets the type for this datastore object
 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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractUserDef

public dkAbstractUserDef()
Constructs a new dkAbstractUserDef class without owner datastore object.

dkAbstractUserDef

public dkAbstractUserDef(dkDatastore ds)
Constructs a new dkAbstractUserDef class with owner datastore object
Parameters:
ds - reference to owner datastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkUserDef
Following copied from interface: com.ibm.mm.sdk.common.dkUserDef
Parameters:
ds - datastore

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkUserDef
Returns:
the dkDatastore object

datastoreType

public java.lang.String datastoreType()
                               throws java.lang.Exception
Gets the type for this datastore object
Specified by:
datastoreType in interface dkUserDef
Returns:
datastore type
Throws:
DKException - if error occurs

getName

public java.lang.String getName()
Gets User name
Specified by:
getName in interface dkUserDef
Returns:
name of this user

setName

public void setName(java.lang.String name)
Sets User name
Specified by:
setName in interface dkUserDef
Parameters:
name - new name to be set to this User object

getDescription

public java.lang.String getDescription()
Get the description of this user
Specified by:
getDescription in interface dkUserDef
Returns:
string containing description.

setDescription

public void setDescription(java.lang.String desc)
Sets description of this user
Specified by:
setDescription in interface dkUserDef
Parameters:
desc - description about this user

getFullName

public java.lang.String getFullName()
Gets user full name
Specified by:
getFullName in interface dkUserDef
Returns:
full name of this user

setFullName

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

setPassword

public void setPassword(java.lang.String authentication)
Sets user password
Specified by:
setPassword in interface dkUserDef
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

Specified by:
changePassword in interface dkUserDef

EIP Java APIs

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