Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface DatabaseEngine.PlayerData

Enclosing interface:

DatabaseEngine

public static interface DatabaseEngine.PlayerData

Table category: DBPLAYERDATA A record of Data information from the database. This is usually a XML document record of some sort. Since it is keyed by player, it is typically very safe to obliterate all records belonging to a player name whenever the player needs to go.

Method Summary

Modifier and Type	Method	Description
java.lang.String	key()	Sets the unique key that identifies this record of data.
DatabaseEngine.PlayerData	key(java.lang.String key)	Sets the unique key that identifies this record of data.
java.lang.String	section()	Gets the section/category to which this data belongs.
DatabaseEngine.PlayerData	section(java.lang.String section)	Sets the section/category to which this data belongs.
java.lang.String	who()	Gets the official Name of the player that owns this record.
DatabaseEngine.PlayerData	who(java.lang.String who)	Sets the official Name of the player that owns this record.
java.lang.String	xml()	Gets the actual data document that is the payload of this record.
DatabaseEngine.PlayerData	xml(java.lang.String xml)	Sets the actual data document that is the payload of this record.

Method Detail

who

java.lang.String who()

Gets the official Name of the player that owns this record.

Returns:

name of the player

See Also:

who(String)

who

DatabaseEngine.PlayerData who(java.lang.String who)

Sets the official Name of the player that owns this record.

Parameters:

who - name of the player

Returns:

this

See Also:

who()

section

java.lang.String section()

Gets the section/category to which this data belongs.

Returns:

the data category

See Also:

section(String)

section

DatabaseEngine.PlayerData section(java.lang.String section)

Sets the section/category to which this data belongs.

Parameters:

section - the data category

Returns:

this

See Also:

section()

key

java.lang.String key()

Sets the unique key that identifies this record of data. It must be unique in the whole DB, and can be anything from a GUID to a player/ section combination.

Returns:

the unique record key

See Also:

key(String)

key

DatabaseEngine.PlayerData key(java.lang.String key)

Sets the unique key that identifies this record of data. It must be unique in the whole DB, and can be anything from a GUID to a player/ section combination.

Parameters:

key - the unique record key

Returns:

this

See Also:

key()

xml

java.lang.String xml()

Gets the actual data document that is the payload of this record. It is typically an XML document.

Returns:

the xml document payload

See Also:

xml(String)

xml

DatabaseEngine.PlayerData xml(java.lang.String xml)

Sets the actual data document that is the payload of this record. It is typically an XML document.

Parameters:

xml - the xml document payload

Returns:

this

See Also:

xml()