com.planet_ink.coffee_mud.Common.interfaces
Interface AccountStats

All Superinterfaces:

java.lang.Cloneable, CMCommon, CMObject, java.lang.Comparable<CMObject>

All Known Subinterfaces:

PlayerAccount, PlayerStats

All Known Implementing Classes:

DefaultPlayerAccount, DefaultPlayerStats

public interface AccountStats
extends CMCommon

An interface for a base player account. Shared by PlayerAccount and PlayerStats (since the account system is optional)

Method Summary

long	getAccountExpiration() If the ACCOUNT system is used, this returns the time, in milis since 1970, that this account will expire (meaning the player will no longer be able to log in)
java.lang.String	getEmail() Returns the players email address, if available.
java.util.Set<java.lang.String>	getFriends() Returns a modifiable HashSet that contains the set of player Names that constitutes this players friends.
java.util.Set<java.lang.String>	getIgnored() Returns a modifiable HashSet that contains the set of player Names that constitutes this players ignored player list.
java.lang.String	getXML() Returns an XML representation of all the data in this object, for persistant storage.
long	lastDateTime() The time, in milis since 1970, that the player last logged off.
java.lang.String	lastIP() The last IP address this player logged in from.
long	lastUpdated() The time, in milis since 1970, that the player was last saved.
java.lang.String	notes() Returns the administrative notes entered about this player.
java.lang.String	password() Returns the players password.
void	setAccountExpiration(long newVal) If the ACCOUNT system is used, this sets the time, in milis since 1970, that this account will expire (meaning the player will no longer be able to log in)
void	setEmail(java.lang.String newAdd) Sets the players email address, if available.
void	setLastDateTime(long C) Sets the time, in milis since 1970, that the player last logged off.
void	setLastIP(java.lang.String ip) Sets the last IP address this player logged in from.
void	setLastUpdated(long time) Sets the time, in milis since 1970, that the player was last saved.
void	setNotes(java.lang.String newnotes) Sets the administrative notes entered about this player.
void	setPassword(java.lang.String newPassword) Sets the players password.
void	setXML(java.lang.String str) Restores the data in this object from an XML document.

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getEmail

java.lang.String getEmail()

Returns the players email address, if available.

Returns:

the players email address, if available.

See Also:

setEmail(String)

setEmail

void setEmail(java.lang.String newAdd)

Sets the players email address, if available.

Parameters:

newAdd - the players email address, if available.

See Also:

getEmail()

lastDateTime

long lastDateTime()

The time, in milis since 1970, that the player last logged off.

Returns:

time, in milis since 1970, that the player last logged off.

See Also:

setLastDateTime(long)

setLastDateTime

void setLastDateTime(long C)

Sets the time, in milis since 1970, that the player last logged off.

Parameters:

C - the time, in milis since 1970, that the player last logged off.

See Also:

lastDateTime()

lastUpdated

long lastUpdated()

The time, in milis since 1970, that the player was last saved.

Returns:

the time, in milis since 1970, that the player was last saved.

See Also:

setLastUpdated(long)

setLastUpdated

void setLastUpdated(long time)

Sets the time, in milis since 1970, that the player was last saved.

Parameters:

time - the time, in milis since 1970, that the player was last saved.

See Also:

lastUpdated()

password

java.lang.String password()

Returns the players password.

Returns:

the players password.

See Also:

setPassword(String)

setPassword

void setPassword(java.lang.String newPassword)

Sets the players password.

Parameters:

newPassword - the players password.

See Also:

password()

lastIP

java.lang.String lastIP()

The last IP address this player logged in from.

Returns:

the last IP address this player logged in from.

See Also:

setLastIP(String)

setLastIP

void setLastIP(java.lang.String ip)

Sets the last IP address this player logged in from.

Parameters:

ip - the last IP address this player logged in from.

See Also:

lastIP()

getAccountExpiration

long getAccountExpiration()

If the ACCOUNT system is used, this returns the time, in milis since 1970, that this account will expire (meaning the player will no longer be able to log in)

Returns:

the time, in milis, that this player expires.

See Also:

setAccountExpiration(long)

setAccountExpiration

void setAccountExpiration(long newVal)

If the ACCOUNT system is used, this sets the time, in milis since 1970, that this account will expire (meaning the player will no longer be able to log in)

Parameters:

newVal - the time, in milis, that this player expires.

See Also:

getAccountExpiration()

notes

java.lang.String notes()

Returns the administrative notes entered about this player.

Returns:

the administrative notes entered about this player.

See Also:

setNotes(String)

setNotes

void setNotes(java.lang.String newnotes)

Sets the administrative notes entered about this player.

Parameters:

newnotes - the administrative notes entered about this player.

See Also:

notes()

getFriends

java.util.Set<java.lang.String> getFriends()

Returns a modifiable HashSet that contains the set of player Names that constitutes this players friends.

Returns:

a set of player friend names

getIgnored

java.util.Set<java.lang.String> getIgnored()

Returns a modifiable HashSet that contains the set of player Names that constitutes this players ignored player list.

Returns:

a set of player ignored player list Names

getXML

java.lang.String getXML()

Returns an XML representation of all the data in this object, for persistant storage.

Returns:

an XML representation of all the data in this object

See Also:

setXML(String)

setXML

void setXML(java.lang.String str)

Restores the data in this object from an XML document.

Parameters:

str - an XML representation of all the data in this object

See Also:

getXML()