com.zphinx.spine.members
Class Member

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
All Implemented Interfaces:
DataTransferObject, Serializable
Direct Known Subclasses:
Group, User

public abstract class Member
extends Identifier

A member object is the super object which dictates the properties of Users,Administrators,Groups and Applications registered within the Spine framework.

Version:
1.4 Date: Mon Sep 13 14:58:28 BST 2004

copyright ©Zphinx Software Solutions

Author:
David Ladapo
See Also:
Group, User, Administrator, Application, Serialized Form

Nested Class Summary
protected  class Member.MemberPermissionFactory
          A permission Factory to create a permission for use by a Member called by implementations of getPermission
 
Nested classes/interfaces inherited from class com.zphinx.spine.vo.dto.SpineBean
SpineBean.PermissionFactory
 
Field Summary
 
Fields inherited from class com.zphinx.spine.members.Identity
ADMINISTRATOR, APPLICATION, GROUP, USER
 
Constructor Summary
Member()
          Public Constructor
 
Method Summary
 int getActivity()
          Return the maintenance activity to be taken by this member object.
 String getAddress()
          Return the address of this member.
 ArrayList getAdministrators()
          Get the Administrators who can administer to this object
 Date getBirthDate()
          Gets this members birth date
 String getBirthDateString()
          Gets this members birth date as a string in the format DD/MM/YYYY
 String getCity()
          Return the city of origin of this member.
 String getCompanyName()
          Return the companyName of this member.
 StringAttributeBean getCountry()
          Return the country of origin of this member.
 String getFax()
          Return the fax number of this member.
 String getGender()
          Return the gender of this member.
 String[] getGroupId()
          Return the ids of the groups this member belongs to.
 StringAttributeBean getGroupName()
          Get the group name this member belongs to.
 ArrayList getGroupNames()
          Get the groups this member belongs to.
 String getLastIp()
          Return the last Ip address this member logged in from.
 Date getLastLogin()
          Return the last Login date of this member.
 String getMemberName()
          Get the short name for this member object i.e User,Group or Administrator
abstract  SpinePermission getPermission()
          Gets a clone of the SpinePermission for this object.The SpinePermission can be reset if necessary but a clone is always returned so that external operations does not affect the security state of this object.
 String getPhone()
          Return the phone number of this member.
 String getPostCode()
          Return the post/zip code of this member.
 StringAttributeBean getState()
          Return the state of origin of this member.
 String getUrl()
          Return the url representing the homepage of this member.
 void setActivity(int activity)
          Set the maintenance activity to be taken by this member object.
 void setAddress(String address)
          Set the address of this member.
 void setAdministrators(ArrayList administrators)
          Add some Administrators to this object.
 void setBirthDate(Date birthDate)
          Gets this members birth date
 void setBirthDateString(String birthDateString)
          Sets the birthDate String
 void setCity(String city)
          Set the new city of origin of this member..
 void setCompanyName(String companyName)
          Set the new company name of this member.
 void setCountry(String countryId)
          Set the new country of origin of this member.
 void setCountry(StringAttributeBean country)
          Set the new country of origin of this member.
 void setFax(String fax)
          Set the new fax number of this member.
 void setGender(String gender)
          Set the new gender of this member.
 void setGroupId(String[] groupId)
          Add some more Group ids
 void setGroupName(StringAttributeBean groupName)
          Set the group name this member belongs to.
 void setGroupNames(ArrayList groupNames)
           
 void setLastIp(String lastIp)
          Set the last Ip address this member logged in from.
 void setLastLogin(Date lastLogin)
          Set the last Login date of this member.
 void setPhone(String phone)
          Set the new phone number of this member.
 void setPostCode(String postCode)
          Set The new post/zip code of this member.
 void setState(String stateId)
          Set the new state of origin of this member.
 void setState(StringAttributeBean bean)
          Set the new state of origin of this member.
 void setUrl(String url)
          Set the new url representing the homepage of this member.
 
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, setUserName
 
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
 

Constructor Detail

Member

public Member()
Public Constructor

Method Detail

getMemberName

public String getMemberName()
Get the short name for this member object i.e User,Group or Administrator

Returns:
String A short name for this member object

getGroupId

public String[] getGroupId()
Return the ids of the groups this member belongs to.

Returns:
String[] The array of groupIds.

setGroupId

public void setGroupId(String[] groupId)
Add some more Group ids

Parameters:
groupId - The array of group ids

getAddress

public String getAddress()
Return the address of this member.

Returns:
String The address of this member.

setAddress

public void setAddress(String address)
Set the address of this member.

Parameters:
address - The new address of this member.

getGroupName

public StringAttributeBean getGroupName()
Get the group name this member belongs to.

Returns:
StringAttributeBean The group name of this member.

setGroupName

public void setGroupName(StringAttributeBean groupName)
Set the group name this member belongs to.

Parameters:
groupName - The new groupName

getGroupNames

public ArrayList getGroupNames()
Get the groups this member belongs to.

Returns:
ArrayList A collection of group names

setGroupNames

public void setGroupNames(ArrayList groupNames)
Parameters:
groupNames - an array of StringAttributeBeans representing the names of individual groups

getCity

public String getCity()
Return the city of origin of this member.

Returns:
String The city of origin of this member.

setCity

public void setCity(String city)
Set the new city of origin of this member..

Parameters:
city - The new city of origin of this member.

getState

public StringAttributeBean getState()
Return the state of origin of this member.

Returns:
StringAttributeBean The state of origin of this member.

setState

public void setState(StringAttributeBean bean)
Set the new state of origin of this member.

Parameters:
bean - The new state of origin of this member.

setState

public void setState(String stateId)
Set the new state of origin of this member.

Parameters:
stateId - The new state of origin of this member.

getPostCode

public String getPostCode()
Return the post/zip code of this member.

Returns:
String The post code / zip code of this member.

setPostCode

public void setPostCode(String postCode)
Set The new post/zip code of this member.

Parameters:
postCode - The new post/zip code of this member.

getCountry

public StringAttributeBean getCountry()
Return the country of origin of this member.

Returns:
StringAttributeBean The country of origin of this member.

setCountry

public void setCountry(StringAttributeBean country)
Set the new country of origin of this member.

Parameters:
country - The country of origin of this member.

setCountry

public void setCountry(String countryId)
Set the new country of origin of this member.

Parameters:
countryId - The country of origin of this member.

getCompanyName

public String getCompanyName()
Return the companyName of this member.

Returns:
String The companyName of this member.

setCompanyName

public void setCompanyName(String companyName)
Set the new company name of this member.

Parameters:
companyName - The company name of this member.

getPhone

public String getPhone()
Return the phone number of this member.

Returns:
String The phone number of this member.

setPhone

public void setPhone(String phone)
Set the new phone number of this member.

Parameters:
phone - The new phone number of this member.

getFax

public String getFax()
Return the fax number of this member.

Returns:
String The fax number of this member

setFax

public void setFax(String fax)
Set the new fax number of this member.

Parameters:
fax - The fax number of this member

getGender

public String getGender()
Return the gender of this member.

Returns:
String The gender of this member

setGender

public void setGender(String gender)
Set the new gender of this member.

Parameters:
gender - The new gender

getUrl

public String getUrl()
Return the url representing the homepage of this member.

Returns:
URL The URL object representing the homepage of this member

setUrl

public void setUrl(String url)
Set the new url representing the homepage of this member.

Parameters:
url - A Url Object representing the new url

getLastIp

public String getLastIp()
Return the last Ip address this member logged in from.

Returns:
String The last Ip address the member logged in from.

setLastIp

public void setLastIp(String lastIp)
Set the last Ip address this member logged in from.

Parameters:
lastIp - The last Ip address this member logged in from.

setAdministrators

public void setAdministrators(ArrayList administrators)
Add some Administrators to this object.

Parameters:
administrators - An array of Administrator StringAttributeBean objects to add to this object.

getAdministrators

public ArrayList getAdministrators()
Get the Administrators who can administer to this object

Returns:
ArrayList A collection of Administrator StringAttributeBean objects who can administer to this object

getLastLogin

public Date getLastLogin()
Return the last Login date of this member.

Returns:
Date The last login date

setLastLogin

public void setLastLogin(Date lastLogin)
Set the last Login date of this member.

Parameters:
lastLogin - The last time this member Logged on to the system.

getActivity

public int getActivity()
Return the maintenance activity to be taken by this member object.

Returns:
int The maintenance activity to be taken by this member object.

setActivity

public void setActivity(int activity)
Set the maintenance activity to be taken by this member object.

Parameters:
activity - The new maintenance activity to be taken by this member object.

getBirthDate

public Date getBirthDate()
Gets this members birth date

Returns:
Returns the birthDate.

getBirthDateString

public String getBirthDateString()
Gets this members birth date as a string in the format DD/MM/YYYY

Returns:
Returns the birthDate.

setBirthDate

public void setBirthDate(Date birthDate)
Gets this members birth date

Parameters:
birthDate - The birthDate to set.

setBirthDateString

public void setBirthDateString(String birthDateString)
Sets the birthDate String

Parameters:
birthDateString -

getPermission

public abstract SpinePermission getPermission()
Description copied from class: SpineBean
Gets a clone of the SpinePermission for this object.The SpinePermission can be reset if necessary but a clone is always returned so that external operations does not affect the security state of this object.

Overrides:
getPermission in class SpineBean
Returns:
SpinePermission A SpinePermission for this member object
See Also:
SpinePermission