com.tootsville.user
Class TootUserTrailer

java.lang.Object
  org.starhope.appius.util.SimpleDataRecord<TootUserTrailer>
      com.tootsville.user.TootUserTrailer

All Implemented Interfaces:

com.whirlycott.cache.Cacheable, Serializable, Comparable<TootUserTrailer>, CTime, DataRecord, HasSubversionRevision

public class TootUserTrailer
extends SimpleDataRecord<TootUserTrailer>

WRITEME: Document this type.

Author:

brpocock@star-hope.org

See Also:

Serialized Form

Field Summary

(package private) int	basic8Choice The Toot from the Basic 8 that they originally chose.
private int	id user ID
private static long	serialVersionUID Java serialisation unique ID
private int	tootTimeLeft The number of hours remaining of this user's Toot Timer
private int	tootTimeLeftMinutes The number of minutes (beyond the hour) remaining of this user's Toot Timer
private boolean	tootTimerDay If true, the user's Toot Timer will refill every day CV tootTimerMonth
private int	tootTimeRefill The number of hours which are added to the Toot Timer on each refill.
private boolean	tootTimerMonth If true, the user's Toot Timer will refill every month.

Fields inherited from class org.starhope.appius.util.SimpleDataRecord

myLoader, timeLastChanged, timeLastSaved

Constructor Summary

TootUserTrailer()
WRITEME: Document this constructor brpocock@star-hope.org

TootUserTrailer(TootUserTrailerLoader loader)
WRITEME: Document this constructor brpocock@star-hope.org

Method Summary

int	getBasic8Choice()
int	getCacheableID() Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.
String	getCacheableIdent() Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.
int	getID()
String	getSubversionRevision() Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.
int	getTootTimeLeft()
int	getTootTimeLeftMinutes()
int	getTootTimeRefill()
boolean	isTootTimerDay()
boolean	isTootTimerMonth()
void	setBasic8Choice(int choice)
void	setID(int userID)
void	setTootTimeLeft(int hours)
void	setTootTimeLeftMinutes(int minutesToSet)
void	setTootTimerDay(boolean timeTootsByDay)
void	setTootTimeRefill(int refillAmount)
void	setTootTimerMonth(boolean timeTootsByMonth)

Methods inherited from class org.starhope.appius.util.SimpleDataRecord

changed, checkStale, compareTo, equals, finalize, getRecordLoader, getTimeLastChanged, getTimeLastSaved, hashCode, isBeingLoaded, markAsLoaded, markAsSaved, markForReload, onRemove, onRetrieve, onStore, save, setRecordLoader, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Java serialisation unique ID

See Also:

Constant Field Values

basic8Choice

int basic8Choice

The Toot from the Basic 8 that they originally chose.

tootTimeLeft

private int tootTimeLeft

The number of hours remaining of this user's Toot Timer

tootTimeLeftMinutes

private int tootTimeLeftMinutes

The number of minutes (beyond the hour) remaining of this user's Toot Timer

tootTimerDay

private boolean tootTimerDay

If true, the user's Toot Timer will refill every day CV tootTimerMonth

tootTimeRefill

private int tootTimeRefill

The number of hours which are added to the Toot Timer on each refill.

tootTimerMonth

private boolean tootTimerMonth

If true, the user's Toot Timer will refill every month. CV tootTimerDay

id

private int id

user ID

Constructor Detail

TootUserTrailer

public TootUserTrailer()

WRITEME: Document this constructor brpocock@star-hope.org

TootUserTrailer

public TootUserTrailer(TootUserTrailerLoader loader)

WRITEME: Document this constructor brpocock@star-hope.org

Parameters:

loader - WRITEME

Method Detail

getBasic8Choice

public int getBasic8Choice()

Returns:

the basic8Choice

getCacheableID

public int getCacheableID()
                   throws NotFoundException

Description copied from interface: DataRecord

Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.

Returns:

an unique ID number

Throws:

NotFoundException - if the item doesn't have a distinct numeric ID

See Also:

DataRecord.getCacheableID()

getCacheableIdent

public String getCacheableIdent()

Description copied from interface: DataRecord

Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.

Returns:

an unique identifier string

See Also:

DataRecord.getCacheableIdent()

getID

public int getID()

Returns:

the user ID for which this is a trailer record

getSubversionRevision

public String getSubversionRevision()

Description copied from interface: HasSubversionRevision

Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.

As an example,the Subversion revision string for this file is "$Rev: 1983 $"

 
 @Override
 public String getSubversionRevision () {
        return "$Rev: ";
 }
 

Returns:

The Subversion revision level for this class's source code file.

See Also:

HasSubversionRevision.getSubversionRevision()

getTootTimeLeft

public int getTootTimeLeft()

Returns:

the tootTimeLeft

getTootTimeLeftMinutes

public int getTootTimeLeftMinutes()

Returns:

the tootTimeLeftMinutes

getTootTimeRefill

public int getTootTimeRefill()

Returns:

the tootTimeRefill

isTootTimerDay

public boolean isTootTimerDay()

Returns:

the tootTimerDay

isTootTimerMonth

public boolean isTootTimerMonth()

Returns:

the tootTimerMonth

setBasic8Choice

public void setBasic8Choice(int choice)

Parameters:

choice - the basic8Choice to set

setID

public void setID(int userID)

Parameters:

userID - the new user ID

setTootTimeLeft

public void setTootTimeLeft(int hours)

Parameters:

hours - the tootTimeLeft to set

setTootTimeLeftMinutes

public void setTootTimeLeftMinutes(int minutesToSet)

Parameters:

minutesToSet - the tootTimeLeftMinutes to set

setTootTimerDay

public void setTootTimerDay(boolean timeTootsByDay)

Parameters:

timeTootsByDay - the tootTimerDay to set

setTootTimeRefill

public void setTootTimeRefill(int refillAmount)

Parameters:

refillAmount - the tootTimeRefill to set

setTootTimerMonth

public void setTootTimerMonth(boolean timeTootsByMonth)

Parameters:

timeTootsByMonth - the tootTimerMonth to set