applicationLogic
Class UserSession

java.lang.Object
  extended by applicationLogic.UserSession

public class UserSession
extends java.lang.Object

UserSession keeps track of user session information.

Author:
02leungi

Constructor Summary
UserSession(java.lang.String userID, java.lang.String userType)
          Initialize logged in user's data.
UserSession(java.lang.String userID, java.lang.String userType, int ohip)
          Initialize logged in user's data.
 
Method Summary
 java.lang.String getAssumedUserType()
          Get the assumed user type of this admin user.
 int getOhip()
          Get the logged in user's OHIP number.
 java.util.Map getUserData()
          Get the logged in user's user data.
 java.lang.String getUserId()
          Get the logged in user's ID.
 java.lang.String getUserType()
          Get the logged in user's user type.
 boolean isLoggedIn()
          Checks if the user is logged in.
 void setAssumedUserType(java.lang.String assumedUserType)
          Set the assumed user type of this admin user.
 void setLogin(boolean update)
          Updates the status of the session.
 void setUserData(java.util.Map newData)
          Replace the user data with new user data.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserSession

public UserSession(java.lang.String userID,
                   java.lang.String userType)
Initialize logged in user's data.

Parameters:
userID - ID of user.
userType - Type of user.

UserSession

public UserSession(java.lang.String userID,
                   java.lang.String userType,
                   int ohip)
Initialize logged in user's data.

Parameters:
userID - ID of user.
userType - Type of user.
ohip - OHIP number of logged in user.
Method Detail

getUserId

public java.lang.String getUserId()
Get the logged in user's ID.

Returns:
The logged in user's ID.

getUserType

public java.lang.String getUserType()
Get the logged in user's user type.

Returns:
The logged in user's user type.

getOhip

public int getOhip()
Get the logged in user's OHIP number.

Returns:
The logged in user's OHIP number.

setAssumedUserType

public void setAssumedUserType(java.lang.String assumedUserType)
Set the assumed user type of this admin user.

Parameters:
assumedUserType - The user type assumed for accessing information.

getAssumedUserType

public java.lang.String getAssumedUserType()
Get the assumed user type of this admin user.

Returns:
The assumed user type of this admin user.

getUserData

public java.util.Map getUserData()
Get the logged in user's user data.

Returns:
The logged in user's user data.

setUserData

public void setUserData(java.util.Map newData)
Replace the user data with new user data.

Parameters:
newData - The new data to be used for 'userData'.

isLoggedIn

public boolean isLoggedIn()
Checks if the user is logged in.

Returns:
'loggedIn' true if the user is logged in.

setLogin

public void setLogin(boolean update)
Updates the status of the session.

Parameters:
true - if the user is logging in.