DJDoc v.1.0.0b-1

net.sf.djdoc.bo
Class UserVO

java.lang.Object
  extended by net.sf.djdoc.bo.UserVO
All Implemented Interfaces:
User
Direct Known Subclasses:
UserEntity

public class UserVO
extends java.lang.Object
implements User

The class UserVO is a concrete implementation of the User interface. It implements the Value Object design pattern.


Constructor Summary
protected UserVO()
          Protected no-argument constructor; overridden by the UserEntity class.
  UserVO(User that)
          Public copy constructor.
 
Method Summary
 java.lang.String getName()
          Getter method for this UserVO's name.
 byte getViewPref()
          Getter method for this UserVO's view preferences.
 void setName(java.lang.String name)
          Setter method for this UserVO's name.
 void setViewPref(byte viewPref)
          Setter method for this UserVO's view preferences.
 void toggleViewPref(byte mask)
          This method toggles an aspect of the user's view preferences (between "collapsed" and "expanded").
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserVO

public UserVO(User that)
Public copy constructor.

Parameters:
that - The User instance whose attribute values are to be copied to this UserVO object.

UserVO

protected UserVO()
Protected no-argument constructor; overridden by the UserEntity class.

Method Detail

getName

public java.lang.String getName()
Getter method for this UserVO's name.

Specified by:
getName in interface User
Returns:
The name of the user

setName

public void setName(java.lang.String name)
Setter method for this UserVO's name.

Specified by:
setName in interface User
Parameters:
name - The name of the user

getViewPref

public byte getViewPref()
Getter method for this UserVO's view preferences.

Specified by:
getViewPref in interface User
Returns:
The current view preferences of the UserVO

setViewPref

public void setViewPref(byte viewPref)
Setter method for this UserVO's view preferences.

Specified by:
setViewPref in interface User
Parameters:
viewPref - The new view preferences of the UserVO

toggleViewPref

public void toggleViewPref(byte mask)
This method toggles an aspect of the user's view preferences (between "collapsed" and "expanded").

Specified by:
toggleViewPref in interface User
Parameters:
mask - A bit mask specifying which aspect of the user's view preference settings to modify

DJDoc v.1.0.0b-1