org.gxos.users
Interface PersonalInfo

All Known Implementing Classes:
GSPersonal, CGPersonal

public interface PersonalInfo

An interface class for personal information implementers. All types of personal information providers need to implement this class.

$Id: PersonalInfo.java,v 1.10 2001/06/29 21:46:26 balsoy Exp $


Method Summary
 void constructFromHashtable(UserObject user, java.util.Hashtable values)
          Fills the fields of a user object with values given in a hashtable.
 void constructPersonalInfo(UserObject user, java.lang.String userID, java.lang.String pwd, java.lang.String firstName, java.lang.String midName, java.lang.String lastName, java.lang.String pres, java.lang.String sufs, java.lang.String email)
          Method for user personal information implementer.
 PersonalInfoTypeType getInfoType()
          Returns PersonalInfoType for this implementer.
 UserObject getUserObject()
          Returns an empty User object which complies with this personal information standards.
 boolean hasEmail(UserObject user, java.lang.String email)
          Checks if a user has the given e-mail address in her email address list.
 java.util.Hashtable returnHashtable(UserObject user)
          Returns a hashtable whose values are retrieved from the given user object.
 boolean securityCheck(UserObject user, java.lang.String password, java.lang.String access)
          Checks if this user is authorized to perform a certain group of tasks.
 void updateFromHashtable(UserObject user, java.util.Hashtable values)
          Updates the fields of a user object with values given in a hashtable.
 

Method Detail

getInfoType

public PersonalInfoTypeType getInfoType()
Returns PersonalInfoType for this implementer.
Returns:
infoType One of VC for VirtualClassroom, IMS for IMS Enterprise Info Model, and PAPI for PAPI model.
See Also:
PersonalInfoTypeType

getUserObject

public UserObject getUserObject()
Returns an empty User object which complies with this personal information standards.
Returns:
a user object whose parameters are not set.

constructPersonalInfo

public void constructPersonalInfo(UserObject user,
                                  java.lang.String userID,
                                  java.lang.String pwd,
                                  java.lang.String firstName,
                                  java.lang.String midName,
                                  java.lang.String lastName,
                                  java.lang.String pres,
                                  java.lang.String sufs,
                                  java.lang.String email)
Method for user personal information implementer.
Parameters:
user - User object whose personal information will be set.
name - Full name of a user, i.e. James J Smith, John Doe
pre - Prefix for the name if any, i.e. Prof.
suf - Suffix for the name if any, i.e. Jr.

constructFromHashtable

public void constructFromHashtable(UserObject user,
                                   java.util.Hashtable values)
Fills the fields of a user object with values given in a hashtable.
Parameters:
user - user object whose personal information will be set.
a - hashtable which later will be used to construct a user object.

updateFromHashtable

public void updateFromHashtable(UserObject user,
                                java.util.Hashtable values)
                         throws GxException
Updates the fields of a user object with values given in a hashtable.
Parameters:
user - user object whose personal information will be set.
a - hashtable which later will be used to modify a user object.
Throws:
GxException - if any error is encountered. See implementations for further details.

returnHashtable

public java.util.Hashtable returnHashtable(UserObject user)
Returns a hashtable whose values are retrieved from the given user object.
Parameters:
user - user object whose personal information will be returned.
Returns:
a hashtable whose data is filled from a user object.

hasEmail

public boolean hasEmail(UserObject user,
                        java.lang.String email)
Checks if a user has the given e-mail address in her email address list.
Parameters:
email - e-mail address of this user.
Returns:
true if e-mail address is in user's address list; false otherwise.

securityCheck

public boolean securityCheck(UserObject user,
                             java.lang.String password,
                             java.lang.String access)
Checks if this user is authorized to perform a certain group of tasks.
Parameters:
user - user whose information will be validated.
password - password which is assigned to this user.
access - security domain where user tries to access, i.e. account information, meeting information system configuration, user management
Returns:
true if this user passes security check; false otherwise.