com.zphinx.spine.vo.dto
Class SpineBean

java.lang.Object
  extended by com.zphinx.spine.vo.dto.SpineBean
All Implemented Interfaces:
DataTransferObject, Serializable
Direct Known Subclasses:
AccountDetails, Identity

public abstract class SpineBean
extends Object
implements DataTransferObject

SpineBean contains the base properties of all classes that can be managed by Spine.

A SpineBean contains base properties which can be used by client programmers to define subclasses and provides features which are needed by spine to identify objects which it can manipulate.

Version:
$1.0

Copyright ©Zphinx Software Solutions

Author:
David Ladapo
See Also:
Serialized Form

Nested Class Summary
 class SpineBean.PermissionFactory
          A permission Factory to create a permission for use by this object, called by implementations of SpineBean to retrieve a suitable SpinePrmission
 
Constructor Summary
SpineBean()
          Public Constructor
 
Method Summary
 long getCreationDate()
          Gets this objects creation date, normally created in the constructor of this object
 String getDescription()
          Gets the description of this object
 long getId()
          Gets the id of this object
 Locale getLocale()
          Gets the Locale where the creator of this DTO is using the system
 Date getModifiedDate()
          Gets this objects last modified date
 String getName()
          Gets the name of this object
 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 getSessionId()
          Gets a unique ID for this transaction which is used to identify this object across multiple tiers
 void setCreationDate(long longDate)
          Sets this objects creation date
 void setDescription(String description)
          Sets the description of this object
 void setId(long id)
          Sets the id of this object
 void setLocale(Locale locale)
           
 void setModifiedDate(Date modifiedDate)
          Sets this objects last modified date
 void setName(String name)
          Sets the name of this object
 void setPermission(SpinePermission permission)
          Set the permission object associated with this user
 void setSessionId(String sessionId)
          Sets this beans sessionId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpineBean

public SpineBean()
Public Constructor

Method Detail

getId

public long getId()
Gets the id of this object

Returns:
Returns the id.

setId

public void setId(long id)
Sets the id of this object

Parameters:
id - The id to set.

getDescription

public String getDescription()
Gets the description of this object

Returns:
Returns the description.

setDescription

public void setDescription(String description)
Sets the description of this object

Parameters:
description - The description to set.

getName

public String getName()
Gets the name of this object

Returns:
Returns the name.

setName

public void setName(String name)
Sets the name of this object

Parameters:
name - The name to set.

getPermission

public 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.

Returns:
SpinePermission A SpinePermission for this member object
See Also:
SpinePermission

setPermission

public void setPermission(SpinePermission permission)
Set the permission object associated with this user

Parameters:
permission - The permission object associated with this user

getCreationDate

public long getCreationDate()
Gets this objects creation date, normally created in the constructor of this object

Returns:
Returns the creationDate.

setCreationDate

public void setCreationDate(long longDate)
Sets this objects creation date

Parameters:
longDate - The creationDate to set.

getModifiedDate

public Date getModifiedDate()
Gets this objects last modified date

Returns:
Returns the modifiedDate.

setModifiedDate

public void setModifiedDate(Date modifiedDate)
Sets this objects last modified date

Parameters:
modifiedDate - The modifiedDate to set.

getSessionId

public String getSessionId()
Description copied from interface: DataTransferObject
Gets a unique ID for this transaction which is used to identify this object across multiple tiers

Specified by:
getSessionId in interface DataTransferObject
Returns:
A unique ID useful for identifying this object

setSessionId

public void setSessionId(String sessionId)
Sets this beans sessionId

Parameters:
sessionId - the sessionId to set

getLocale

public Locale getLocale()
Description copied from interface: DataTransferObject
Gets the Locale where the creator of this DTO is using the system

Specified by:
getLocale in interface DataTransferObject
Returns:
The Locale of the user of this DTO

setLocale

public void setLocale(Locale locale)
Parameters:
locale - the locale to set