com.siebel.rf.offline.data.user
Class User

java.lang.Object
  |
  +--com.siebel.rf.offline.data.user.User
All Implemented Interfaces:
Persisted

public class User
extends java.lang.Object
implements Persisted

The User persisted class


Field Summary
 java.lang.String accessProviderId
           
 java.lang.String activeRoleId
           
 java.lang.String branchCode
           
 java.lang.Double depositLimit
           
 java.lang.String entityType
           
 java.lang.String isTemporarilyLoggedOff
           
 java.lang.String lastLoggedInDate
           
 java.lang.String lastLoggedInTime
           
static java.util.HashMap MAPPING
           
 java.lang.String parentActorId
           
static java.util.ArrayList PK_ATTRBUTES
           
 java.lang.String preferredCashBoxId
           
 java.lang.String processingDate
           
 java.lang.String serializedEntityObjectIdentity
           
 java.lang.String statusIndicator
           
 java.lang.Boolean supervisor
           
 java.lang.String tellerEndOfBusinessDayRequired
           
 java.lang.String tellerEndOfDayRequired
           
 java.lang.String userId
           
 java.lang.String userLanguage
           
 java.lang.String userLoggedIn
           
 java.lang.String userLogonName
           
 java.lang.String userLogonTries
           
 java.lang.String userName
           
 java.lang.String userPassword
           
 java.lang.String userShortName
           
 java.lang.String userType
           
 
Constructor Summary
User()
           
 
Method Summary
 java.lang.Boolean checkFinalSignOffDetails()
          Check Final SignOff Details of user
 void compareCashBoxId(java.lang.String cashBoxId)
          Compares preferredCashBoxId with passed cashBoxId
 boolean equals(java.lang.Object object)
          Compares the object.
 java.lang.String getAccessProviderId()
          Returns accessProviderId
 java.lang.String getActiveRoleId()
          Returns activeRoleId
 java.lang.String getBranchCode()
          Returns branchCode
 Teller getCurrentTellerObject(java.lang.String branchCode)
          Returns the current Teller for this user
 java.lang.Double getDepositLimit()
          Returns depositLimit
 java.lang.String getEntityType()
          Returns entityType
 java.lang.String getIsTemporarilyLoggedOff()
          Returns isTemporarilyLoggedOff
 java.lang.String getLastLoggedInDate()
          Returns lastLoggedInDate
 java.lang.String getLastLoggedInTime()
          Returns lastLoggedInTime
 java.util.HashMap getMapping()
          Returns collection of primary key attributes
 Teller getMostRecentTellerObject(java.lang.String branchCode)
          Returns the most recent Teller.
 java.lang.String getParentActorId()
          Returns parentActorId
 java.util.ArrayList getPKAttributes()
          Returns the collection of primary key attributes
 java.lang.String getPreferredCashBoxId()
          Returns preferredCashBoxId
 java.lang.String getProcessingDate()
          Returns processingDate
 java.lang.String getSerializedEntityObjectIdentity()
          Returns serializedEntityObjectIdentity
 java.lang.String getStatusIndicator()
          Returns statusIndicator
 java.lang.Boolean getSupervisor()
          Returns supervisor
 java.lang.String getTableName()
          Returns tableName of User
 java.lang.String getTellerEndOfBusinessDayRequired()
          Returns tellerEndOfBusinessDayRequired
 java.lang.String getTellerEndOfDayRequired()
          Returns tellerEndOfDayRequired
 java.lang.String getUserId()
          Returns userId
 java.lang.String getUserLanguage()
          Returns userLanguage
 java.lang.String getUserLoggedIn()
          Returns userLoggedIn
 java.lang.String getUserLogonName()
          Returns userLogonName
 java.lang.String getUserLogonTries()
          Returns userLogonTries
 java.lang.String getUserName()
          Returns userName
 java.lang.String getUserPassword()
          Returns userPassword
 java.lang.String getUserShortName()
          Returns userShortName
 java.lang.String getUserType()
          Returns userType
 void incrementUserLogonTries()
          Increments the number of logon tries by 1
 java.lang.Boolean isASupervisor()
          Checks whether User is a supervisor
 java.lang.Boolean isTellerEndOfBusinessDayRequired()
          Check whether user is required to do a Teller End of Business Day before logging off.
 java.lang.Boolean isTellerEndOfDayRequired()
          Check whether user is required to do a Teller End of Day before logging off.
 java.lang.Boolean isTellerStartOfDayRequired()
          Check whether user is Required to do a teller Start Of Day.
 java.lang.Boolean isUserLoggedIn()
          Checks whether user is logged in
 java.lang.Boolean isUserLoggedOffOrTemporarilyLoggedOff()
          Checks whether user is logged off or temporarily logged off
 void lockActor()
          Sets the current User instance to Locked
 void logoffUserTemporarily()
          Sets an user temporarily logged off
 void resetUserLogonTries()
          Reset userLogonTries Attribute Value to 0
 void setAccessProviderId(java.lang.String accessProviderId)
          Sets accessProviderId
 void setActiveRoleId(java.lang.String activeRoleId)
          Sets activeRoleId
 void setBranchCode(java.lang.String branchCode)
          Sets branchCode
 void setDepositLimit(java.lang.Double depositLimit)
          Sets depositLimit
 void setEntityType(java.lang.String entityType)
          Sets entityType
 void setIsTemporarilyLoggedOff(java.lang.String isTemporarilyLoggedOff)
          Sets isTemporarilyLoggedOff
 void setLastLoggedInDate(java.lang.String lastLoggedInDate)
          Sets lastLoggedInDate
 void setLastLoggedInTime(java.lang.String lastLoggedInTime)
          Sets lastLoggedInTime
 void setParentActorId(java.lang.String parentActorId)
          Sets parentActorId
 void setPreferredCashBoxId(java.lang.String preferredCashBoxId)
          Sets preferredCashBoxId
 void setProcessingDate(java.lang.String processingDate)
          Sets processingDate
 void setSerializedEntityObjectIdentity(java.lang.String serializedEntityObjectIdentity)
          Sets serializedEntityObjectIdentity
 void setStatusIndicator(java.lang.String statusIndicator)
          Sets statusIndicator
 void setSupervisor(java.lang.Boolean supervisor)
          Sets supervisor
 void setTellerEndOfBusinessDayRequired(java.lang.String tellerEndOfBusinessDayRequired)
          Sets tellerEndOfBusinessDayRequired
 void setTellerEndOfDayRequired(java.lang.String tellerEndOfDayRequired)
          Sets tellerEndOfDayRequired
 void setUserId(java.lang.String userId)
          Sets userId
 void setUserLanguage(java.lang.String userLanguage)
          Sets userLanguage
 java.lang.Boolean setUserLoggedIn()
          Sets the actor's LoggedIn Attribute to Y.
 void setUserLoggedIn(java.lang.String userLoggedIn)
          Sets userLoggedIn
 void setUserLoggedOff()
          Sets user logged off
 void setUserLogonName(java.lang.String userLogonName)
          Sets userLogonName
 void setUserLogonTries(java.lang.String userLogonTries)
          Sets userLogonTries
 void setUserName(java.lang.String userName)
          Sets userName
 void setUserPassword(java.lang.String userPassword)
          Sets userPassword
 void setUserShortName(java.lang.String userShortName)
          Sets userShortName
 void setUserType(java.lang.String userType)
          Sets userType
 com.bankframe.bo.DataPacket toDataPacket()
          Creates dataPacket for User
 java.lang.String toString()
          Converts DataPacket to String.
 void updatePreferredCashboxId(java.lang.String preferredCashBoxId)
          Updates the preferredCashBoxId
 void updateProcessingDate(java.lang.String date)
          Updates processingDate
 java.lang.Boolean validateUserPassword(java.lang.String password)
          Compares userPassword with passed password
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

accessProviderId

public java.lang.String accessProviderId

userId

public java.lang.String userId

statusIndicator

public java.lang.String statusIndicator

activeRoleId

public java.lang.String activeRoleId

entityType

public java.lang.String entityType

serializedEntityObjectIdentity

public java.lang.String serializedEntityObjectIdentity

isTemporarilyLoggedOff

public java.lang.String isTemporarilyLoggedOff

lastLoggedInDate

public java.lang.String lastLoggedInDate

lastLoggedInTime

public java.lang.String lastLoggedInTime

userLoggedIn

public java.lang.String userLoggedIn

userLogonTries

public java.lang.String userLogonTries

userPassword

public java.lang.String userPassword

userType

public java.lang.String userType

parentActorId

public java.lang.String parentActorId

userLogonName

public java.lang.String userLogonName

userName

public java.lang.String userName

userShortName

public java.lang.String userShortName

depositLimit

public java.lang.Double depositLimit

branchCode

public java.lang.String branchCode

preferredCashBoxId

public java.lang.String preferredCashBoxId

processingDate

public java.lang.String processingDate

tellerEndOfDayRequired

public java.lang.String tellerEndOfDayRequired

userLanguage

public java.lang.String userLanguage

tellerEndOfBusinessDayRequired

public java.lang.String tellerEndOfBusinessDayRequired

supervisor

public java.lang.Boolean supervisor

MAPPING

public static java.util.HashMap MAPPING

PK_ATTRBUTES

public static java.util.ArrayList PK_ATTRBUTES
Constructor Detail

User

public User()
Method Detail

getAccessProviderId

public java.lang.String getAccessProviderId()
Returns accessProviderId
Returns:
the value of accessProviderId

getUserId

public java.lang.String getUserId()
Returns userId
Returns:
the value of userId

getStatusIndicator

public java.lang.String getStatusIndicator()
Returns statusIndicator
Returns:
the value of statusIndicator

getActiveRoleId

public java.lang.String getActiveRoleId()
Returns activeRoleId
Returns:
the value of activeRoleId

getEntityType

public java.lang.String getEntityType()
Returns entityType
Returns:
the value of entityType

getSerializedEntityObjectIdentity

public java.lang.String getSerializedEntityObjectIdentity()
Returns serializedEntityObjectIdentity
Returns:
the value of serializedEntityObjectIdentity

getIsTemporarilyLoggedOff

public java.lang.String getIsTemporarilyLoggedOff()
Returns isTemporarilyLoggedOff
Returns:
the value of isTemporarilyLoggedOff

getLastLoggedInDate

public java.lang.String getLastLoggedInDate()
Returns lastLoggedInDate
Returns:
the value of lastLoggedInDate

getLastLoggedInTime

public java.lang.String getLastLoggedInTime()
Returns lastLoggedInTime
Returns:
the value of lastLoggedInTime

getUserLoggedIn

public java.lang.String getUserLoggedIn()
Returns userLoggedIn
Returns:
the value of userLoggedIn

getUserLogonTries

public java.lang.String getUserLogonTries()
Returns userLogonTries
Returns:
the value of userLogonTries

getUserPassword

public java.lang.String getUserPassword()
Returns userPassword
Returns:
the value of userPassword

getUserType

public java.lang.String getUserType()
Returns userType
Returns:
the value of userType

getParentActorId

public java.lang.String getParentActorId()
Returns parentActorId
Returns:
the value of parentActorId

getUserLogonName

public java.lang.String getUserLogonName()
Returns userLogonName
Returns:
the value of userLogonName

getUserName

public java.lang.String getUserName()
Returns userName
Returns:
the value of userName

getUserShortName

public java.lang.String getUserShortName()
Returns userShortName
Returns:
the value of userShortName

getDepositLimit

public java.lang.Double getDepositLimit()
Returns depositLimit
Returns:
the value of depositLimit

getBranchCode

public java.lang.String getBranchCode()
Returns branchCode
Returns:
the value of branchCode

getPreferredCashBoxId

public java.lang.String getPreferredCashBoxId()
Returns preferredCashBoxId
Returns:
the value of preferredCashBoxId

getProcessingDate

public java.lang.String getProcessingDate()
Returns processingDate
Returns:
the value of processingDate

getTellerEndOfDayRequired

public java.lang.String getTellerEndOfDayRequired()
Returns tellerEndOfDayRequired
Returns:
the value of tellerEndOfDayRequired

getUserLanguage

public java.lang.String getUserLanguage()
Returns userLanguage
Returns:
the value of userLanguage

getTellerEndOfBusinessDayRequired

public java.lang.String getTellerEndOfBusinessDayRequired()
Returns tellerEndOfBusinessDayRequired
Returns:
the value of tellerEndOfBusinessDayRequired

getSupervisor

public java.lang.Boolean getSupervisor()
Returns supervisor
Returns:
the value of supervisor

setAccessProviderId

public void setAccessProviderId(java.lang.String accessProviderId)
Sets accessProviderId
Parameters:
accessProviderId - String

setUserId

public void setUserId(java.lang.String userId)
Sets userId
Parameters:
userId - String

setStatusIndicator

public void setStatusIndicator(java.lang.String statusIndicator)
Sets statusIndicator
Parameters:
statusIndicator - String

setActiveRoleId

public void setActiveRoleId(java.lang.String activeRoleId)
Sets activeRoleId
Parameters:
activeRoleId - String

setEntityType

public void setEntityType(java.lang.String entityType)
Sets entityType
Parameters:
entityType - String

setSerializedEntityObjectIdentity

public void setSerializedEntityObjectIdentity(java.lang.String serializedEntityObjectIdentity)
Sets serializedEntityObjectIdentity
Parameters:
serializedEntityObjectIdentity - String

setIsTemporarilyLoggedOff

public void setIsTemporarilyLoggedOff(java.lang.String isTemporarilyLoggedOff)
Sets isTemporarilyLoggedOff
Parameters:
isTemporarilyLoggedOff - String

setLastLoggedInDate

public void setLastLoggedInDate(java.lang.String lastLoggedInDate)
Sets lastLoggedInDate
Parameters:
lastLoggedInDate - String

setLastLoggedInTime

public void setLastLoggedInTime(java.lang.String lastLoggedInTime)
Sets lastLoggedInTime
Parameters:
lastLoggedInTime - String

setUserLoggedIn

public void setUserLoggedIn(java.lang.String userLoggedIn)
Sets userLoggedIn
Parameters:
userLoggedIn - String

setUserLogonTries

public void setUserLogonTries(java.lang.String userLogonTries)
Sets userLogonTries
Parameters:
userLogonTries - String

setUserPassword

public void setUserPassword(java.lang.String userPassword)
Sets userPassword
Parameters:
userPassword - String

setUserType

public void setUserType(java.lang.String userType)
Sets userType
Parameters:
userType - String

setParentActorId

public void setParentActorId(java.lang.String parentActorId)
Sets parentActorId
Parameters:
parentActorId - String

setUserLogonName

public void setUserLogonName(java.lang.String userLogonName)
Sets userLogonName
Parameters:
userLogonName - String

setUserName

public void setUserName(java.lang.String userName)
Sets userName
Parameters:
userName - String

setUserShortName

public void setUserShortName(java.lang.String userShortName)
Sets userShortName
Parameters:
userShortName - String

setDepositLimit

public void setDepositLimit(java.lang.Double depositLimit)
Sets depositLimit
Parameters:
depositLimit - Double

setBranchCode

public void setBranchCode(java.lang.String branchCode)
Sets branchCode
Parameters:
branchCode - String

setPreferredCashBoxId

public void setPreferredCashBoxId(java.lang.String preferredCashBoxId)
Sets preferredCashBoxId
Parameters:
preferredCashBoxId - String

setProcessingDate

public void setProcessingDate(java.lang.String processingDate)
Sets processingDate
Parameters:
processingDate - String

setTellerEndOfDayRequired

public void setTellerEndOfDayRequired(java.lang.String tellerEndOfDayRequired)
Sets tellerEndOfDayRequired
Parameters:
tellerEndOfDayRequired - String

setUserLanguage

public void setUserLanguage(java.lang.String userLanguage)
Sets userLanguage
Parameters:
userLanguage - String

setTellerEndOfBusinessDayRequired

public void setTellerEndOfBusinessDayRequired(java.lang.String tellerEndOfBusinessDayRequired)
Sets tellerEndOfBusinessDayRequired
Parameters:
tellerEndOfBusinessDayRequired - String

setSupervisor

public void setSupervisor(java.lang.Boolean supervisor)
Sets supervisor
Parameters:
supervisor - Boolean

getMapping

public java.util.HashMap getMapping()
Returns collection of primary key attributes
Specified by:
getMapping in interface Persisted
Returns:
the collection of primary key attributes

getPKAttributes

public java.util.ArrayList getPKAttributes()
Returns the collection of primary key attributes
Specified by:
getPKAttributes in interface Persisted
Returns:
the collection of primary key attributes

getTableName

public java.lang.String getTableName()
Returns tableName of User
Specified by:
getTableName in interface Persisted
Returns:
the tableName

toDataPacket

public com.bankframe.bo.DataPacket toDataPacket()
Creates dataPacket for User
Specified by:
toDataPacket in interface Persisted
Returns:
dataPacket

toString

public java.lang.String toString()
Converts DataPacket to String.
Overrides:
toString in class java.lang.Object
Returns:
String after converting the DataPacket to String

equals

public boolean equals(java.lang.Object object)
Compares the object.
Overrides:
equals in class java.lang.Object
Parameters:
object - Object
Returns:
boolean after comparing the object

getCurrentTellerObject

public Teller getCurrentTellerObject(java.lang.String branchCode)
                              throws com.bankframe.validation.ValidationException,
                                     com.bankframe.ejb.ProcessingErrorException
Returns the current Teller for this user
Parameters:
String - branchCode
Returns:
the current Teller for this user, branch and companyCode
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

validateUserPassword

public java.lang.Boolean validateUserPassword(java.lang.String password)
Compares userPassword with passed password
Parameters:
String - password
Returns:
true if userPassword equals passed password else false.

compareCashBoxId

public void compareCashBoxId(java.lang.String cashBoxId)
                      throws com.bankframe.ejb.ProcessingErrorException
Compares preferredCashBoxId with passed cashBoxId
Parameters:
String - cashBoxId
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if preferredCashBoxId is not equal to passed cashBoxId

setUserLoggedIn

public java.lang.Boolean setUserLoggedIn()
                                  throws com.bankframe.ejb.ProcessingErrorException,
                                         com.bankframe.validation.ValidationException
Sets the actor's LoggedIn Attribute to Y.
Returns:
true
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

resetUserLogonTries

public void resetUserLogonTries()
                         throws com.bankframe.validation.ValidationException
Reset userLogonTries Attribute Value to 0
Throws:
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

incrementUserLogonTries

public void incrementUserLogonTries()
                             throws com.bankframe.ejb.ProcessingErrorException,
                                    com.bankframe.validation.ValidationException
Increments the number of logon tries by 1
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

isUserLoggedOffOrTemporarilyLoggedOff

public java.lang.Boolean isUserLoggedOffOrTemporarilyLoggedOff()
                                                        throws com.bankframe.ejb.ProcessingErrorException,
                                                               com.bankframe.validation.ValidationException
Checks whether user is logged off or temporarily logged off
Returns:
true if user is logged in but temporarily logged off or not logged in and false if user is not temporarily logged off
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

isUserLoggedIn

public java.lang.Boolean isUserLoggedIn()
                                 throws com.bankframe.ejb.ProcessingErrorException,
                                        com.bankframe.validation.ValidationException
Checks whether user is logged in
Returns:
true if user is logged in
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

lockActor

public void lockActor()
               throws com.bankframe.validation.ValidationException
Sets the current User instance to Locked
Throws:
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

setUserLoggedOff

public void setUserLoggedOff()
                      throws com.bankframe.ejb.ProcessingErrorException,
                             com.bankframe.validation.ValidationException
Sets user logged off
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

isASupervisor

public java.lang.Boolean isASupervisor()
Checks whether User is a supervisor
Returns:
true if User is supervisior else false

isTellerEndOfBusinessDayRequired

public java.lang.Boolean isTellerEndOfBusinessDayRequired()
                                                   throws com.bankframe.validation.ValidationException
Check whether user is required to do a Teller End of Business Day before logging off.
Returns:
true if user is required to do a Teller End of Business Day before logging off else false
Throws:
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

isTellerEndOfDayRequired

public java.lang.Boolean isTellerEndOfDayRequired()
Check whether user is required to do a Teller End of Day before logging off.
Returns:
true if user is required to do a Teller End of Day before logging off else false.

logoffUserTemporarily

public void logoffUserTemporarily()
                           throws com.bankframe.ejb.ProcessingErrorException,
                                  com.bankframe.validation.ValidationException
Sets an user temporarily logged off
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

updatePreferredCashboxId

public void updatePreferredCashboxId(java.lang.String preferredCashBoxId)
                              throws com.bankframe.validation.ValidationException
Updates the preferredCashBoxId
Parameters:
preferredCashBoxId - String
Throws:
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

isTellerStartOfDayRequired

public java.lang.Boolean isTellerStartOfDayRequired()
                                             throws com.bankframe.ejb.ProcessingErrorException
Check whether user is Required to do a teller Start Of Day.
Returns:
true if user is required to do a teller Start of day else false.
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails

checkFinalSignOffDetails

public java.lang.Boolean checkFinalSignOffDetails()
                                           throws com.bankframe.validation.ValidationException
Check Final SignOff Details of user
Returns:
true if teller is not required to do end of day and end of business day else false.
Throws:
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

updateProcessingDate

public void updateProcessingDate(java.lang.String date)
                          throws com.bankframe.validation.ValidationException
Updates processingDate
Parameters:
date - String
Throws:
com.bankframe.validation.ValidationException - This exception is thrown if validation fails

getMostRecentTellerObject

public Teller getMostRecentTellerObject(java.lang.String branchCode)
                                 throws com.bankframe.ejb.ProcessingErrorException
Returns the most recent Teller.
Parameters:
branchCode - String
Returns:
the most recent Teller
Throws:
com.bankframe.ejb.ProcessingErrorException - This exception is thrown if processing fails