edu.rice.rubis.beans
Interface User

All Superinterfaces:
javax.ejb.EJBObject, java.rmi.Remote

public interface User
extends javax.ejb.EJBObject

This is the Remote Interface of the User Bean.

Version:
1.0
Author:
Emmanuel Cecchet

Method Summary
 float getBalance()
          Get user's account current balance.
 java.lang.String getCreationDate()
          Get user creation date.
 java.lang.String getEmail()
          Get user email address.
 java.lang.String getFirstName()
          Get user first name.
 java.lang.String getHTMLGeneralUserInformation()
          Returns a string displaying general information about the user.
 java.lang.Integer getId()
          Get user's id.
 java.lang.String getLastName()
          Get user last name.
 java.lang.String getNickName()
          Get user nick name.
 java.lang.String getPassword()
          Get user password.
 int getRating()
          Get user rating.
 java.lang.Integer getRegionId()
          Get region identifier of user's region.
 void setBalance(float newBalance)
          Set user's account current balance.
 void setCreationDate(java.lang.String newCreationDate)
          Set a new creation date for this user account
 void setEmail(java.lang.String newEmail)
          Set user's email address
 void setFirstName(java.lang.String newName)
          Set user's first name
 void setLastName(java.lang.String newName)
          Set user's last name
 void setNickName(java.lang.String newName)
          Set user's nick name
 void setPassword(java.lang.String newPassword)
          Set user's password
 void setRating(int newRating)
          Set user rating.
 void setRegionId(java.lang.Integer id)
          Set a new region identifier.
 void updateRating(int diff)
          Update the current rating by adding a new value to it.
 
Methods inherited from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
 

Method Detail

getId

public java.lang.Integer getId()
                        throws java.rmi.RemoteException
Get user's id.
Returns:
user id
Throws:
java.rmi.RemoteException - if an error occurs

getFirstName

public java.lang.String getFirstName()
                              throws java.rmi.RemoteException
Get user first name.
Returns:
user first name
Throws:
java.rmi.RemoteException - if an error occurs

getLastName

public java.lang.String getLastName()
                             throws java.rmi.RemoteException
Get user last name.
Returns:
user last name
Throws:
java.rmi.RemoteException - if an error occurs

getNickName

public java.lang.String getNickName()
                             throws java.rmi.RemoteException
Get user nick name. This name is unique for each user and is used for login.
Returns:
user nick name
Throws:
java.rmi.RemoteException - if an error occurs

getPassword

public java.lang.String getPassword()
                             throws java.rmi.RemoteException
Get user password.
Returns:
user password
Throws:
java.rmi.RemoteException - if an error occurs

getEmail

public java.lang.String getEmail()
                          throws java.rmi.RemoteException
Get user email address.
Returns:
user email address
Throws:
java.rmi.RemoteException - if an error occurs

getRating

public int getRating()
              throws java.rmi.RemoteException
Get user rating. The higher the rating is, the most reliable the user is.
Returns:
user rating
Throws:
java.rmi.RemoteException - if an error occurs

getBalance

public float getBalance()
                 throws java.rmi.RemoteException
Get user's account current balance. This account is used when a user want to sell items. There is a charge for each item to sell.
Returns:
user's account current balance
Throws:
java.rmi.RemoteException - if an error occurs

getCreationDate

public java.lang.String getCreationDate()
                                 throws java.rmi.RemoteException
Get user creation date.
Returns:
user creation date
Throws:
java.rmi.RemoteException - if an error occurs

getRegionId

public java.lang.Integer getRegionId()
                              throws java.rmi.RemoteException
Get region identifier of user's region.
Returns:
region id of the user
Throws:
java.rmi.RemoteException - if an error occurs

setFirstName

public void setFirstName(java.lang.String newName)
                  throws java.rmi.RemoteException
Set user's first name
Parameters:
newName - user first name
Throws:
java.rmi.RemoteException - if an error occurs

setLastName

public void setLastName(java.lang.String newName)
                 throws java.rmi.RemoteException
Set user's last name
Parameters:
newName - user last name
Throws:
java.rmi.RemoteException - if an error occurs

setNickName

public void setNickName(java.lang.String newName)
                 throws java.rmi.RemoteException
Set user's nick name
Parameters:
newName - user nick name
Throws:
java.rmi.RemoteException - if an error occurs

setPassword

public void setPassword(java.lang.String newPassword)
                 throws java.rmi.RemoteException
Set user's password
Parameters:
newPassword - a String value
Throws:
java.rmi.RemoteException - if an error occurs

setEmail

public void setEmail(java.lang.String newEmail)
              throws java.rmi.RemoteException
Set user's email address
Parameters:
newEmail - a String value
Throws:
java.rmi.RemoteException - if an error occurs

setCreationDate

public void setCreationDate(java.lang.String newCreationDate)
                     throws java.rmi.RemoteException
Set a new creation date for this user account
Parameters:
newCreationDate - new user account creation date
Throws:
java.rmi.RemoteException - if an error occurs

setRegionId

public void setRegionId(java.lang.Integer id)
                 throws java.rmi.RemoteException
Set a new region identifier. This id must match the primary key of the region table.
Parameters:
id - region id
Throws:
java.rmi.RemoteException - if an error occurs

setRating

public void setRating(int newRating)
               throws java.rmi.RemoteException
Set user rating. The higher the rating is, the most reliable the user is.
Parameters:
newRating - new user rating
Throws:
java.rmi.RemoteException - if an error occurs

updateRating

public void updateRating(int diff)
                  throws java.rmi.RemoteException
Update the current rating by adding a new value to it. This value can be negative if someone wants to decrease the user rating.
Parameters:
diff - value to add to the rating
Throws:
java.rmi.RemoteException - if an error occurs

setBalance

public void setBalance(float newBalance)
                throws java.rmi.RemoteException
Set user's account current balance. This account is used when a user want to sell items. There is a charge for each sold item.
Parameters:
newBalance - set user's account current balance
Throws:
java.rmi.RemoteException - if an error occurs

getHTMLGeneralUserInformation

public java.lang.String getHTMLGeneralUserInformation()
                                               throws java.rmi.RemoteException
Returns a string displaying general information about the user. The string contains HTML tags.
Returns:
string containing general user information
Throws:
java.rmi.RemoteException - if an error occurs


Copyright © 2003 - ObjectWeb Consortium - All Rights Reserved.