com.zphinx.spine.members
Class User

java.lang.Object
  extended by com.zphinx.spine.vo.dto.SpineBean
      extended by com.zphinx.spine.members.Identity
          extended by com.zphinx.spine.members.Identifier
              extended by com.zphinx.spine.members.Member
                  extended by com.zphinx.spine.members.User
All Implemented Interfaces:
MemberActions, PrincipalActions, DataTransferObject, Serializable
Direct Known Subclasses:
Administrator

public class User
extends Member
implements PrincipalActions

A User object represents a registered user within the spine framework. It stores all the details of a user within the spine framework and provides implementation methods for the relevant activities taken by this user.

Version:
$Revision: 1.14 $ $Date: 2008/06/15 01:47:09 $

Copyright © Zphinx software solutions

Author:
David Ladapo
See Also:
Member, Administrator, PrincipalActions, Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.zphinx.spine.members.Member
Member.MemberPermissionFactory
 
Nested classes/interfaces inherited from class com.zphinx.spine.vo.dto.SpineBean
SpineBean.PermissionFactory
 
Field Summary
protected static String ACCOUNT_DETAILS
          The name for the account details object
 
Fields inherited from class com.zphinx.spine.members.Identity
ADMINISTRATOR, APPLICATION, GROUP, USER
 
Constructor Summary
User()
          Constructor for object
 
Method Summary
 AccountDetails getAccountDetails()
          Gets this Users account details
 SpinePermission getPermission()
          Implementation of getPermission in Member, returns the SpinePermission Object associated with this Object.Uses MemberPermissionFactory.getMemberPermission to create the appropriate SpinePermission
 Member getPrincipal()
          Get the type of member object
 void setAccountDetails(AccountDetails accountDetails)
          Sets this Users account details
 void setUserName(String s)
          Sets the userName into the name field of the identifier
 
Methods inherited from class com.zphinx.spine.members.Member
getActivity, getAddress, getAdministrators, getBirthDate, getBirthDateString, getCity, getCompanyName, getCountry, getFax, getGender, getGroupId, getGroupName, getGroupNames, getLastIp, getLastLogin, getMemberName, getPhone, getPostCode, getState, getUrl, setActivity, setAddress, setAdministrators, setBirthDate, setBirthDateString, setCity, setCompanyName, setCountry, setCountry, setFax, setGender, setGroupId, setGroupName, setGroupNames, setLastIp, setLastLogin, setPhone, setPostCode, setState, setState, setUrl
 
Methods inherited from class com.zphinx.spine.members.Identifier
getAccountSecrets, setAccountSecrets
 
Methods inherited from class com.zphinx.spine.members.Identity
getEmailAddress, getFirstName, getLastName, getUserName, setEmailAddress, setFirstName, setLastName
 
Methods inherited from class com.zphinx.spine.vo.dto.SpineBean
getCreationDate, getDescription, getId, getLocale, getModifiedDate, getName, getSessionId, setCreationDate, setDescription, setId, setLocale, setModifiedDate, setName, setPermission, setSessionId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.zphinx.spine.members.MemberActions
getActivity, setActivity
 

Field Detail

ACCOUNT_DETAILS

protected static final String ACCOUNT_DETAILS
The name for the account details object

See Also:
Constant Field Values
Constructor Detail

User

public User()
Constructor for object

Method Detail

getPrincipal

public Member getPrincipal()
Get the type of member object

Specified by:
getPrincipal in interface PrincipalActions
Returns:
Member Return this object

getPermission

public SpinePermission getPermission()
Implementation of getPermission in Member, returns the SpinePermission Object associated with this Object.Uses MemberPermissionFactory.getMemberPermission to create the appropriate SpinePermission

Specified by:
getPermission in class Member
Returns:
MemberPermission The SpinePermission object associated with this user
See Also:
SpinePermission

getAccountDetails

public AccountDetails getAccountDetails()
Gets this Users account details

Returns:
Returns the accountDetails.

setAccountDetails

public void setAccountDetails(AccountDetails accountDetails)
Sets this Users account details

Parameters:
accountDetails - The accountDetails to set.

setUserName

public void setUserName(String s)
Sets the userName into the name field of the identifier

Overrides:
setUserName in class Identity
Parameters:
s - The new user name of this member.