de.hs_rm.cs.lecturenotes.shared.entity
Class User

java.lang.Object
  extended by de.hs_rm.cs.lecturenotes.shared.entity.User
All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable, IFieldVerifier
Direct Known Subclasses:
UnregisteredUser

public abstract class User
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable, IFieldVerifier

System Object and DAO Transfer Object User from the Entity Model.

Author:
Enrico Homann

Method Summary
 java.util.List<java.lang.String> checkValidity()
          Will check the validity of the entity and return a List of error messages or a List with no messages (size 0).
 java.lang.String fillTemplate(java.lang.String template)
          Will return a String based upon a template where the tags were replaced using the attribute tags of the persisted table and the attributes of this object.
 UserDiscriminatorEnum getClassUserDiscriminator()
          Will return the current userDiscriminator by this object class.
 java.lang.Long getCreationUnixTimestamp()
          Will return the creation unix timestamp.
 java.lang.Boolean getDeletable()
          Will return the deletable fleg, that indicates whether the user is deletable or not.
 java.lang.String getDisplayName()
          Will return the display name.
 java.lang.String getEmailAddress()
          Will return the email address.
 java.lang.Long getId()
          Will return the id.
 java.lang.Long getLastModifiedUnixTimestamp()
          Will return the last modified unix timestamp.
 java.lang.String getLoginName()
          Will return the login name.
 java.lang.String getLoginPasswordSha()
          Will return the login password sha-256 hash.
 UserDiscriminatorEnum getUserRoleId()
          Will return the user role id.
 void setCreationUnixTimestamp(java.lang.Long nCreationUnixTimestamp)
          Sets the creation unix timestamp.
 void setDeletable(java.lang.Boolean bDeletable)
          Sets the deletable flag.
 void setDisplayName(java.lang.String sDisplayName)
          Sets the display name.
 void setEmailAddress(java.lang.String sEmailAddress)
          Sets the email address.
 void setId(java.lang.Long nId)
          Sets the id.
 void setLastModifiedUnixTimestamp(java.lang.Long nLastModifiedUnixTimestamp)
          Sets the last modified unix timestamp.
 void setLoginName(java.lang.String sLoginName)
          Sets the login name.
 void setLoginPasswordSha(java.lang.String sLoginPasswordSha)
          Sets the login password sha-256 hash.
 void setUserRoleId(UserDiscriminatorEnum oUserRoleId)
          Sets the user role id.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getId

public final java.lang.Long getId()
Will return the id.

Returns:
Long

setId

public final void setId(java.lang.Long nId)
Sets the id.

Parameters:
nId - Long

getLoginName

public final java.lang.String getLoginName()
Will return the login name.

Returns:
String

setLoginName

public final void setLoginName(java.lang.String sLoginName)
Sets the login name.

Parameters:
sLoginName - String

getLoginPasswordSha

public final java.lang.String getLoginPasswordSha()
Will return the login password sha-256 hash.

Returns:
String

setLoginPasswordSha

public final void setLoginPasswordSha(java.lang.String sLoginPasswordSha)
Sets the login password sha-256 hash.

Parameters:
sLoginPasswordSha - String

getDisplayName

public final java.lang.String getDisplayName()
Will return the display name.

Returns:
String

setDisplayName

public final void setDisplayName(java.lang.String sDisplayName)
Sets the display name.

Parameters:
sDisplayName - String

getEmailAddress

public final java.lang.String getEmailAddress()
Will return the email address.

Returns:
String

setEmailAddress

public final void setEmailAddress(java.lang.String sEmailAddress)
Sets the email address.

Parameters:
sEmailAddress - String

getCreationUnixTimestamp

public final java.lang.Long getCreationUnixTimestamp()
Will return the creation unix timestamp.

Returns:
Long

setCreationUnixTimestamp

public final void setCreationUnixTimestamp(java.lang.Long nCreationUnixTimestamp)
Sets the creation unix timestamp.

Parameters:
nCreationUnixTimestamp - Long

getLastModifiedUnixTimestamp

public final java.lang.Long getLastModifiedUnixTimestamp()
Will return the last modified unix timestamp.

Returns:
Long

setLastModifiedUnixTimestamp

public final void setLastModifiedUnixTimestamp(java.lang.Long nLastModifiedUnixTimestamp)
Sets the last modified unix timestamp.

Parameters:
nLastModifiedUnixTimestamp - Long

getUserRoleId

public final UserDiscriminatorEnum getUserRoleId()
Will return the user role id.

Returns:
UserDiscriminatorEnum

setUserRoleId

public final void setUserRoleId(UserDiscriminatorEnum oUserRoleId)
Sets the user role id.

Parameters:
oUserRoleId - UserDiscriminatorEnum

getDeletable

public final java.lang.Boolean getDeletable()
Will return the deletable fleg, that indicates whether the user is deletable or not. Usually the user is deletable, all but system default users.

Returns:
Boolean

setDeletable

public final void setDeletable(java.lang.Boolean bDeletable)
Sets the deletable flag.

Parameters:
bDeletable - Boolean

getClassUserDiscriminator

public final UserDiscriminatorEnum getClassUserDiscriminator()
Will return the current userDiscriminator by this object class.

Returns:
UserDiscriminator

fillTemplate

public final java.lang.String fillTemplate(java.lang.String template)
Will return a String based upon a template where the tags were replaced using the attribute tags of the persisted table and the attributes of this object. While the prefix for each template tag is %user_

Parameters:
template - String
Returns:
String String with replaced key tags

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

checkValidity

public final java.util.List<java.lang.String> checkValidity()
Description copied from interface: IFieldVerifier
Will check the validity of the entity and return a List of error messages or a List with no messages (size 0).

Specified by:
checkValidity in interface IFieldVerifier
Returns:
List of String