package com.planet_ink.coffee_mud.Libraries.interfaces;
import com.planet_ink.coffee_mud.core.CMFile.CMVFSFile;
import com.planet_ink.coffee_mud.core.database.ClanLoader;
import com.planet_ink.coffee_mud.core.database.DBConnections;
import com.planet_ink.coffee_mud.core.database.DBConnector;
import com.planet_ink.coffee_mud.core.database.DataLoader;
import com.planet_ink.coffee_mud.core.database.GAbilityLoader;
import com.planet_ink.coffee_mud.core.database.GCClassLoader;
import com.planet_ink.coffee_mud.core.database.GRaceLoader;
import com.planet_ink.coffee_mud.core.database.JournalLoader;
import com.planet_ink.coffee_mud.core.database.MOBloader;
import com.planet_ink.coffee_mud.core.database.PollLoader;
import com.planet_ink.coffee_mud.core.database.QuestLoader;
import com.planet_ink.coffee_mud.core.database.RoomLoader;
import com.planet_ink.coffee_mud.core.database.StatLoader;
import com.planet_ink.coffee_mud.core.database.VFSLoader;
import com.planet_ink.coffee_mud.core.exceptions.CMException;
import com.planet_ink.coffee_mud.core.interfaces.*;
import com.planet_ink.coffee_mud.core.*;
import com.planet_ink.coffee_mud.core.collections.*;
import com.planet_ink.coffee_mud.Abilities.interfaces.*;
import com.planet_ink.coffee_mud.Areas.interfaces.*;
import com.planet_ink.coffee_mud.Behaviors.interfaces.*;
import com.planet_ink.coffee_mud.CharClasses.interfaces.*;
import com.planet_ink.coffee_mud.Commands.interfaces.*;
import com.planet_ink.coffee_mud.Common.interfaces.*;
import com.planet_ink.coffee_mud.Common.interfaces.Clan.MemberRecord;
import com.planet_ink.coffee_mud.Exits.interfaces.*;
import com.planet_ink.coffee_mud.Items.interfaces.*;
import com.planet_ink.coffee_mud.Libraries.interfaces.*;
import com.planet_ink.coffee_mud.Locales.interfaces.*;
import com.planet_ink.coffee_mud.MOBS.interfaces.*;
import com.planet_ink.coffee_mud.Races.interfaces.*;
import java.util.*;
/*
Copyright 2004-2016 Bo Zimmerman
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* Not really much point in saying a lot here.
* This has all the methods most closely related
* to reading from, writing to, and updating
* the database. That's all there is to it.
*
* @author Bo Zimmerman
*
*/
public interface DatabaseEngine extends CMLibrary
{
/**
* An enum of all the database table types.
* These are the dividers by which different
* connections to different databases can be
* assigned to different tables.
*
* @author Bo Zimmerman
*
*/
public static enum DatabaseTables
{
DBABILITY,
DBCHARCLASS,
DBRACE,
DBPLAYERS,
DBPLAYERDATA,
DBMAP,
DBSTATS,
DBPOLLS,
DBVFS,
DBJOURNALS,
DBQUEST,
DBCLANS,
DBBACKLOG
}
/**
* Returns the database status, formatted for html.
* @return the database status, formatted for html.
*/
public String errorStatus();
/**
* Forces all existing database connections to be closed,
* and then re-open.
*/
public void resetConnections();
/**
* Returns the connector object to the database, allowing
* SQL statements to be run.
* @return the connector object to the database
*/
public DBConnector getConnector();
/**
* "Pings" all connections to the database by issueing
* a "SELECT 1 FROM CMCHAR".
* @return the number of connections pinged
*/
public int pingAllConnections();
/**
* "Pings" all connections to the database by issueing
* a "SELECT 1 FROM CMCHAR", if the connection has
* not seen any action in the given number of milliseconds.
* @param overrideTimeoutIntervalMillis the connection timeout
* @return the number of connections pinged
*/
public int pingAllConnections(final long overrideTimeoutIntervalMillis);
/**
* Returns whether the database is connected.
* @return whether the database is connected.
*/
public boolean isConnected();
/**
* Executes an arbitrary SQL statement against your
* main database and returns the response number/code.
* @param sql the SQL statement
* @return the exec response number (usually num rows)
* @throws CMException any errors that occur
*/
public int DBRawExecute(String sql) throws CMException;
/**
* Executes an arbitrary SQL query against your
* main database and returns the results as a list of
* string arrays, where each array is a row, and each
* column is a column from the query.
* @param sql the SQL query
* @return the results of the query
* @throws CMException any errors that occur
*/
public List<String[]> DBRawQuery(String sql) throws CMException;
/**
* Table category: DBMAP
* Loads both the mob and item catalogs into the catalog library.
*/
public void DBReadCatalogs();
/**
* Table category: DBMAP
* Logs all the items in outer space into the space map
*/
public void DBReadSpace();
/**
* Table category: DBMAP
* This method is used to load the content (items and mobs) of the
* given room id into the given room object, and optionally activate
* the contents to live use. startItemRejuv() is not called, however.
*
* @param roomID the id of the room to load
* @param thisRoom the room object to load the content into (required!)
* @param makeLive true to bring the mobs to life, false to leave them dead.
*/
public void DBReadContent(String roomID, Room thisRoom, boolean makeLive);
/**
* Table category: DBMAP
* Reloads the basic data of the given area, with a prefilled Name.
* It does not load or alter rooms or anything like that, only
* the internal variables of the area.
* @param A the area to reload
*/
public void DBReadAreaData(Area A);
/**
* Table category: DBMAP
* Permanently Loads and returns a single Room object,
* without populating its contents yet. This is often done in
* preparation to read the content, the exits, or both.
* It sets the area and room ID, as if the room will have a
* permanent home in the game.
*
* @see DatabaseEngine#DBReadContent(String, Room, boolean)
* @see DatabaseEngine#DBReReadRoomData(Room)
* @see DatabaseEngine#DBReadRoomObject(String, boolean)
*
* @param roomID the room id of the room object to load
* @param reportStatus true to populate global status, false otherwise
* @return the room loaded, or null if it could not be
*/
public Room DBReadRoom(String roomID, boolean reportStatus);
/**
* Table category: DBMAP
* Reloads the title, description, affects, and other internal
* fields of the given room.
* @param room the room to re-read dat afor
* @return true, unless something went wrong
*/
public boolean DBReReadRoomData(Room room);
/**
* Table category: DBMAP
* Read the Room object of the given roomID and returns
* the object. It does not load the contents. The
* difference between this and dbreadroom is beyond me.
* I don't think this method actually adds the room
* to an area or to the map.
* @see DatabaseEngine#DBReadRoom(String, boolean)
* @param roomIDtoLoad the id of the room to load
* @param reportStatus true to populate global status, false otherwise
* @return the room loaded, or null if it could not be
*/
public Room DBReadRoomObject(String roomIDtoLoad, boolean reportStatus);
/**
* Table category: DBMAP
* Reads all the Room objects in the given area name
* and returns them as an array of rooms. It does not load the
* item or mob contents. The rooms are not actually
* added to the Area or the map.
* @param areaName the area name of rooms to load
* @param reportStatus
* @param reportStatus true to populate global status, false otherwise
* @return the rooms loaded
*/
public Room[] DBReadRoomObjects(String areaName, boolean reportStatus);
/**
* Table category: DBMAP
* Reads the room description of the given room id and
* returns it.
* @param roomID the room id of the description to read
* @return the description, or null
*/
public String DBReadRoomDesc(String roomID);
/**
* Table category: DBMAP
* Counts the number of mobs and items in the room
* according to the database, and returns the counts
* as a numeric array where the first element is the
* number of mobs and the second the number of items.
* @param roomID the room id to return counts for
* @return the counts as a 2 entry array
*/
public int[] DBCountRoomMobsItems(String roomID);
/**
* Table category: DBMAP
* Reads the exits of the room with the given room id
* and populates them into the given room object. It
* also connects each exit to the room if it can
* get to it through the given rooms area object.
*
* @param roomID the room id
* @param room the room object to populate
* @param reportStatus true to populate global status, false otherwise
*/
public void DBReadRoomExits(String roomID, Room room, boolean reportStatus);
/**
* Table category: DBMAP
* Resaves the given rooms exit objects, and
* linkages to other rooms.
* @param room the room whose exits to save
*/
public void DBUpdateExits(Room room);
/**
* Table category: DBMAP
* Inserts the given item into the given room id
* in the database, regardless of its worthiness to
* be there.
* @param roomID the room id to save the item at
* @param thisItem the item to save
*/
public void DBCreateThisItem(String roomID, Item thisItem);
/**
* Table category: DBMAP
* Inserts the given mob into the given room id
* in the database, regardless of its worthiness to
* be there.
* @param roomID the room id to save the mob at
* @param thisMOB the mob to save
*/
public void DBCreateThisMOB(String roomID, MOB thisMOB);
/**
* Table category: DBMAP
* Given a specific room id, and a specific mob id for
* that room (this is a unique coded string found only
* in the db, and loaded as the database id), this method
* returns the misctext for the mob.
* @see Environmental#text()
* @see MOB#databaseID()
* @param roomID the room id
* @param mobID the unique mob string for that room
* @return the misc text of the mob
*/
public String DBReadRoomMOBMiscText(String roomID, String mobID);
/**
* Table category: DBMAP
* This method does a conventional boot load of all rooms and areas
* in the given set, including exits and content. Thin areas
* are not loaded, as normal. Logging and status are as boot.
* Rooms and Areas are added to the map.
* @param roomsToRead null to read all, or the set of rooms to read
*/
public void DBReadAllRooms(RoomnumberSet roomsToRead);
/**
* Table category: DBMAP
* Deletes all mobs from the given room from the database and then
* adds the given mobs to the database.
* @see DatabaseEngine#DBUpdateMOBs(Room)
* @param room the savable room
* @param mobs the mobs in the room that need saving
*/
public void DBUpdateTheseMOBs(Room room, List<MOB> mobs);
/**
* Table category: DBMAP
* Deletes all items from the given room from the database and then
* adds the given items to the database.
* @param room the savable room
* @param item the items in the room that need saving
*/
public void DBUpdateTheseItems(Room room, List<Item> item);
/**
* Table category: DBMAP
* Deletes all mobs from the given room from the database and then
* adds all mobs currently in the room which are savable back to
* the database.
* @see DatabaseEngine#DBUpdateTheseMOBs(Room, List)
* @param room the savable room
*/
public void DBUpdateMOBs(Room room);
/**
* Table category: DBMAP
* Creates the basic room object entry in the data. Does not
* save content or exits, just the room object stuff.
* @param room the room to save
*/
public void DBCreateRoom(Room room);
/**
* Table category: DBMAP
* Updates only the room object for the given room, not the
* items or content -- just the title, description, behaviors
* and properties, that sort of thing. No exits either.
* Just the room.
* @param room the room that needs resaving.
*/
public void DBUpdateRoom(Room room);
/**
* Table category: DBMAP
* Reads all the room numbers for the area with the given name from the
* database and returns a compressed roomnumberset object.
* @see com.planet_ink.coffee_mud.Common.interfaces.RoomnumberSet
* @param areaName the name of the area to load numbers from
* @param reportStatus true to update the global status, false otherwise
* @return the rooms in this area, as a compressed set
*/
public RoomnumberSet DBReadAreaRoomList(String areaName, boolean reportStatus);
/**
* Table category: DBMAP
* Assuming the given mob is savable, this method will update the
* database record for the given mob in the given room by deleting
* the mob from the room's database record and re-creating him in it.
* @param roomID the id of the room that the mob was in
* @param mob the mob to save
*/
public void DBUpdateMOB(String roomID, MOB mob);
/**
* Table category: DBMAP
* Assuming the given item is savable, this method will update the
* database record for the given item in the given room by deleting
* the item from the room's database record and re-creating it in it.
* @param roomID the id of the room that the item was in
* @param item the item to save
*/
public void DBUpdateItem(String roomID, Item item);
/**
* Table category: DBMAP
* Removes the given mob, and only the given mob, from the database
* records for the given room id.
* @param roomID the id of the room that the mob was in
* @param mob the mob to remove
*/
public void DBDeleteMOB(String roomID, MOB mob);
/**
* Table category: DBMAP
* Removes the given item, and only the given item, from the database
* records for the given room id.
* @param roomID the id of the room that the item was in
* @param item the item to remove
*/
public void DBDeleteItem(String roomID, Item item);
/**
* Table category: DBMAP
* Updates all of the savable items in the given room by
* removing all item records from the database and re-inserting
* all of the current item records back in.
* @param room the room to update
*/
public void DBUpdateItems(Room room);
/**
* Table category: DBMAP
* Changes the room ID of the given room in the database
* by updating all of the records with the old room id
* to instead use the new room id of the room given.
* @param room the room with the new id
* @param oldID the old room id
*/
public void DBReCreate(Room room, String oldID);
/**
* Table category: DBMAP
* Deletes the room and all of its exits and contents
* from the database entirely.
* @param room the room to blow away
*/
public void DBDeleteRoom(Room room);
/**
* Table category: DBMAP
* Creates a new area record in the database.
* Only does the area record, not the rooms.
* @param A the area to create.
*/
public void DBCreateArea(Area A);
/**
* Table category: DBMAP
* Removes the given area record from the database.
* Only does the area record, not the rooms.
* @param A the area to destroy.
*/
public void DBDeleteArea(Area A);
/**
* Table category: DBMAP
* Updates the area record in the database with the
* given areaID with the data from the given area
* object. The areaID and the name of the area can
* be different for area renamings.
* @param areaID the current db area name
* @param A the area data to save
*/
public void DBUpdateArea(String areaID, Area A);
/**
* Table category: DBPLAYERS
* Updates an existing account record in the database
* by altering its key fields in the existing record.
* @param account the account to update
*/
public void DBUpdateAccount(PlayerAccount account);
/**
* Table category: DBPLAYERS
*
* @param account
*/
public void DBCreateAccount(PlayerAccount account);
/**
* Table category: DBPLAYERS
*
* @param account
*/
public void DBDeleteAccount(PlayerAccount account);
/**
* Table category: DBPLAYERS
*
* @param Login
* @return
*/
public PlayerAccount DBReadAccount(String Login);
/**
* Table category: DBPLAYERS
*
* @param mask
* @return
*/
public List<PlayerAccount> DBListAccounts(String mask);
/**
* Table category: DBPLAYERS
* Re-builds the entire top-10 player tables from the
* database. It returns a two dimensional array of
* lists of players and their scores, in reverse sorted
* order by score. The first dimension of the array is
* the time period ordinal (month, year, whatever), and the
* second is the pridestat ordinal.
*
* The cpu percent is the percent (0-100) of each second of work
* to spend actually working. The balance is spent sleeping.
*
* @see com.planet_ink.coffee_mud.Common.interfaces.TimeClock.TimePeriod
* @see com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat
* @param topThisMany the number of items in each list
* @param scanCPUPercent the percent (0-100) to spend working
* @return the arrays of lists of top winner players
*/
public List<Pair<String,Integer>>[][] DBScanPridePlayerWinners(int topThisMany, short scanCPUPercent);
/**
* Table category: DBPLAYERS
* Re-builds the entire top-10 account tables from the
* database. It returns a two dimensional array of
* lists of accounts and their scores, in reverse sorted
* order by score. The first dimension of the array is
* the time period ordinal (month, year, whatever), and the
* second is the pridestat ordinal.
*
* The cpu percent is the percent (0-100) of each second of work
* to spend actually working. The balance is spent sleeping.
*
* @see com.planet_ink.coffee_mud.Common.interfaces.TimeClock.TimePeriod
* @see com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat
* @param topThisMany the number of items in each list
* @param scanCPUPercent the percent (0-100) to spend working
* @return the arrays of lists of top winner accounts
*/
public List<Pair<String,Integer>>[][] DBScanPrideAccountWinners(int topThisMany, short scanCPUPercent);
/**
* Table category: DBPLAYERS
* Does a complete update of the given player mob,
* including their items, abilities, and account.
* Followers are not included.
* @param mob the player mob to update
*/
public void DBUpdatePlayer(MOB mob);
/**
* Table category: DBPLAYERS
* If this system uses the character expiration system, then
* this method will scan all the players for expired characters,
* and return the list of names, or an empty list if there are
* none. The skipNames is a list of protected names that are
* never expired.
* @param skipNames the names to never expire, or null
* @return the list of expired names, or an empty list
*/
public List<String> DBExpiredCharNameSearch(Set<String> skipNames);
/**
* Table category: DBPLAYERS
* Updates only the player stats record for the given player.
* These are player-unique variables, such as the prompt.
* @param mob the player to update
*/
public void DBUpdatePlayerPlayerStats(MOB mob);
/**
* Table category: DBPLAYERS
* Updates only the base mob data in the database for
* the given player. This includes playerstat data
* and clan affiliation records, but not items, or
* abilities, or other such stuff.
* @param mob the player mob to update
*/
public void DBUpdatePlayerMOBOnly(MOB mob);
/**
* Table category: DBPLAYERS
* Updates only the ability records in the database
* for the given player. This also includes effects,
* behaviors, and scripts on players, but nothing else.
* @param mob the player to update
*/
public void DBUpdatePlayerAbilities(MOB mob);
/**
* Table category: DBPLAYERS
* Updates only the item/inventory/equipment records
* in the database for the given player. Nothing else.
* @param mob the player to update
*/
public void DBUpdatePlayerItems(MOB mob);
/**
* Table category: DBPLAYERS
* This method deletes and re-saves the non-player
* npc followers of the given player mob.
* @param mob the mob whose followers to save
*/
public void DBUpdateFollowers(MOB mob);
/**
* Table category: DBPLAYERS
*
* @param name
* @return
*/
public MOB DBReadPlayer(String name);
/**
* Table category: DBPLAYERS
*
* @param oldName
* @param newName
*/
public void DBPlayerNameChange(String oldName, String newName);
/**
* Table category: DBPLAYERS
*
* @param mob
*/
public void DBUpdateEmail(MOB mob);
/**
* Table category: DBPLAYERS
*
* @param name
* @param password
*/
public void DBUpdatePassword(String name, String password);
/**
* Table category: DBPLAYERS
*
* @param name
* @return
*/
public String[] DBFetchEmailData(String name);
/**
* Table category: DBPLAYERS
*
* @param email
* @return
*/
public String DBPlayerEmailSearch(String email);
/**
* Table category: DBPLAYERS
*
* @return
*/
public List<PlayerLibrary.ThinPlayer> getExtendedUserList();
/**
* Table category: DBPLAYERS
*
* @param name
* @return
*/
public PlayerLibrary.ThinPlayer getThinUser(String name);
/**
* Table category: DBPLAYERS
*
* @return
*/
public List<String> getUserList();
/**
* Table category: DBPLAYERS
*
* @param mob
* @return
*/
public List<MOB> DBScanFollowers(MOB mob);
/**
* Table category: DBPLAYERS
*
* @param mob
* @param bringToLife
*/
public void DBReadFollowers(MOB mob, boolean bringToLife);
/**
* Table category: DBPLAYERS
*
* @param mob
* @param deleteAssets
*/
public void DBDeletePlayer(MOB mob, boolean deleteAssets);
/**
* Table category: DBPLAYERS
*
* @param mob
*/
public void DBCreateCharacter(MOB mob);
/**
* Table category: DBPLAYERS
*
* @param Login
* @return
*/
public PlayerLibrary.ThinnerPlayer DBUserSearch(String Login);
/**
* Table category: DBPLAYERS
*
* @param mob
* @param liegeID
* @return
*/
public List<PlayerLibrary.ThinPlayer> vassals(MOB mob, String liegeID);
/**
* Table category: DBPLAYERS
*
* @param deityID
* @return
*/
public List<PlayerLibrary.ThinPlayer> worshippers(String deityID);
/**
* Table category: DBPLAYERS
*
* @param tattoo
* @return
*/
public Tattoo parseTattoo(String tattoo);
/**
* Table category: DBQUEST
*
* @param quests
*/
public void DBUpdateQuests(List<Quest> quests);
/**
* Table category: DBQUEST
*
* @param Q
*/
public void DBUpdateQuest(Quest Q);
/**
* Table category: DBQUEST
*
* @param myHost
*/
public void DBReadQuests(MudHost myHost);
/**
* Table category: DBCLANS
*
* @param clan
* @return
*/
public List<MemberRecord> DBClanMembers(String clan);
/**
* Table category: DBCLANS
*
* @param clan
* @param name
* @return
*/
public MemberRecord DBGetClanMember(String clan, String name);
/**
* Table category: DBCLANS
*
* @param clan
* @param name
* @param adjMobKills
* @param adjPlayerKills
*/
public void DBUpdateClanKills(String clan, String name, int adjMobKills, int adjPlayerKills);
/**
* Table category: DBCLANS
*
* @param name
* @param clan
* @param role
*/
public void DBUpdateClanMembership(String name, String clan, int role);
/**
* Table category: DBCLANS
*
*/
public void DBReadAllClans();
/**
* Table category: DBCLANS
*
* @param C
*/
public void DBUpdateClan(Clan C);
/**
* Table category: DBCLANS
*
* @param C
*/
public void DBUpdateClanItems(Clan C);
/**
* Table category: DBCLANS
*
* @param C
*/
public void DBDeleteClan(Clan C);
/**
* Table category: DBCLANS
*
* @param C
*/
public void DBCreateClan(Clan C);
/**
* Table category: DBJOURNALS
*
* @return
*/
public List<String> DBReadJournals();
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param stats
*/
public void DBUpdateJournalStats(String Journal, JournalsLibrary.JournalSummaryStats stats);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param entry
*/
public void DBUpdateJournal(String Journal, JournalEntry entry);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param searchStr
* @return
*/
public List<JournalEntry> DBSearchAllJournalEntries(String Journal, String searchStr);
/**
* Table category: DBJOURNALS
*
* @param stats
*/
public void DBReadJournalSummaryStats(JournalsLibrary.JournalSummaryStats stats);
/**
* Table category: DBJOURNALS
*
* @param key
* @param numReplies
*/
public void DBUpdateMessageReplies(String key, int numReplies);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param Key
* @return
*/
public JournalEntry DBReadJournalEntry(String Journal, String Key);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param parent
* @param searchStr
* @param newerDate
* @param limit
* @return
*/
public List<JournalEntry> DBReadJournalPageMsgs(String Journal, String parent, String searchStr, long newerDate, int limit);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param ascending TODO
* @return
*/
public List<JournalEntry> DBReadJournalMsgsByUpdateDate(String Journal, boolean ascending);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param ascending
* @param limit
* @return
*/
public List<JournalEntry> DBReadJournalMsgsByUpdateDate(String Journal, boolean ascending, int limit);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param ascending
* @param tos
* @return
*/
public List<JournalEntry> DBReadJournalMsgsByUpdateDate(String Journal, boolean ascending, int limit, String[] tos);
/**
*
* @param journalID
* @param ascending
* @return
*/
public List<JournalEntry> DBReadJournalMsgsByCreateDate(String journalID, boolean ascending);
/**
*
* @param journalID
* @param ascending
* @param limit
* @return
*/
public List<JournalEntry> DBReadJournalMsgsByCreateDate(String journalID, boolean ascending, int limit);
/**
*
* @param journalID
* @param ascending
* @param limit
* @param tos
* @return
*/
public List<JournalEntry> DBReadJournalMsgsByCreateDate(String journalID, boolean ascending, int limit, String[] tos);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param to
* @param olderDate
* @return
*/
public List<JournalEntry> DBReadJournalMsgsNewerThan(String Journal, String to, long olderDate);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param to
* @param newestDate
* @return
*/
public List<JournalEntry> DBReadJournalMsgsOlderThan(String Journal, String to, long newestDate);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param from
* @param to
* @return
*/
public int DBCountJournal(String Journal, String from, String to);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param entry
*/
public void DBWriteJournal(String Journal, JournalEntry entry);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param from
* @param to
* @param subject
* @param message
*/
public void DBWriteJournal(String Journal, String from, String to, String subject, String message);
/**
* Table category: DBJOURNALS
*
* @param MailBox
* @param journalSource
* @param from
* @param to
* @param subject
* @param message
*/
public void DBWriteJournalEmail(String MailBox, String journalSource, String from, String to, String subject, String message);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param key
* @param from
* @param to
* @param subject
* @param message
*/
public void DBWriteJournalReply(String Journal, String key, String from, String to, String subject, String message);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param journalSource
* @param from
* @param to
* @param parentKey
* @param subject
* @param message
*/
public void DBWriteJournalChild(String Journal, String journalSource, String from, String to,
String parentKey, String subject, String message);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param msgKeyOrNull
*/
public void DBDeleteJournal(String Journal, String msgKeyOrNull);
/**
* Table category: DBJOURNALS
*
* @param possibleName
* @return
*/
public String DBGetRealJournalName(String possibleName);
/**
* Table category: DBJOURNALS
*
* @param Journal
* @param to
* @param olderTime
* @return
*/
public long[] DBJournalLatestDateNewerThan(String Journal, String to, long olderTime);
/**
* Table category: DBJOURNALS
*
* @param name
*/
public void DBDeletePlayerJournals(String name);
/**
* Table category: DBJOURNALS
*
* @param key
* @param subject
* @param msg
* @param newAttributes
*/
public void DBUpdateJournal(String key, String subject, String msg, long newAttributes);
/**
* Table category: DBJOURNALS
*
* @param key
* @param views
*/
public void DBViewJournalMessage(String key, int views);
/**
* Table category: DBJOURNALS
*
* @param key
*/
public void DBTouchJournalMessage(String key);
/**
* Table category: DBJOURNALS
*
* @param key
* @param newDate
*/
public void DBTouchJournalMessage(String key, long newDate);
/**
* Table category: DBPLAYERDATA
*
* @param playerID
* @return
*/
public List<PlayerData> DBReadAllPlayerData(String playerID);
/**
* Table category: DBPLAYERDATA
*
* @param playerID
* @param section
* @return
*/
public List<PlayerData> DBReadData(String playerID, String section);
/**
* Table category: DBPLAYERDATA
*
* @param playerID
* @param section
* @return
*/
public int DBCountData(String playerID, String section);
/**
* Table category: DBPLAYERDATA
*
* @param playerID
* @param section
* @param key
* @return
*/
public List<PlayerData> DBReadData(String playerID, String section, String key);
/**
* Table category: DBPLAYERDATA
*
* @param section
* @param keyMask
* @return
*/
public List<PlayerData> DBReadDataKey(String section, String keyMask);
/**
* Table category: DBPLAYERDATA
*
* @param key
* @return
*/
public List<PlayerData> DBReadDataKey(String key);
/**
* Table category: DBPLAYERDATA
*
* @param section
* @return
*/
public List<PlayerData> DBReadData(String section);
/**
* Table category: DBPLAYERDATA
*
* @param player
* @param sections
* @return
*/
public List<PlayerData> DBReadData(String player, List<String> sections);
/**
* Table category: DBPLAYERDATA
*
* @param name
*/
public void DBDeletePlayerData(String name);
/**
* Table category: DBPLAYERDATA
*
* @param playerID
* @param section
*/
public void DBDeleteData(String playerID, String section);
/**
* Table category: DBPLAYERDATA
*
* @param playerID
* @param section
* @param key
*/
public void DBDeleteData(String playerID, String section, String key);
/**
* Table category: DBPLAYERDATA
*
* @param key
* @param xml
*/
public void DBUpdateData(String key, String xml);
/**
* Table category: DBPLAYERDATA
*
* @param name
* @param section
* @param key
* @param xml
*/
public void DBReCreateData(String name, String section, String key, String xml);
/**
* Table category: DBPLAYERDATA
*
* @param section
*/
public void DBDeleteData(String section);
/**
* Table category: DBPLAYERDATA
*
* @param player
* @param section
* @param key
* @param data
*/
public void DBCreateData(String player, String section, String key, String data);
/**
* Table category: DBPLAYERDATA
*
*/
public void DBReadArtifacts();
/**
* Table category: DBPLAYERDATA
*
* @return
*/
public PlayerData createPlayerData();
/**
* Table category: DBRACE
*
* @return
*/
public List<AckRecord> DBReadRaces();
/**
* Table category: DBRACE
*
* @param raceID
*/
public void DBDeleteRace(String raceID);
/**
* Table category: DBRACE
*
* @param raceID
* @param data
*/
public void DBCreateRace(String raceID,String data);
/**
* Table category: DBCHARCLASS
*
* @return
*/
public List<AckRecord> DBReadClasses();
/**
* Table category: DBCHARCLASS
*
* @param classID
*/
public void DBDeleteClass(String classID);
/**
* Table category: DBCHARCLASS
*
* @param classID
* @param data
*/
public void DBCreateClass(String classID,String data);
/**
* Table category: DBABILITY
*
* @return
*/
public List<AckRecord> DBReadAbilities();
/**
*
* @param classID
*/
public void DBDeleteAbility(String classID);
/**
* Table category: DBABILITY
*
* @param classID
* @param typeClass
* @param data
*/
public void DBCreateAbility(String classID, String typeClass, String data);
/**
* Table category: DBSTATS
*
* @param startTime
* @return
*/
public Object DBReadStat(long startTime);
/**
* Table category: DBSTATS
*
* @param startTime
*/
public void DBDeleteStat(long startTime);
/**
* Table category: DBSTATS
*
* @param startTime
* @param endTime
* @param data
* @return
*/
public boolean DBCreateStat(long startTime,long endTime,String data);
/**
* Table category: DBSTATS
*
* @param startTime
* @param data
* @return
*/
public boolean DBUpdateStat(long startTime, String data);
/**
* Table category: DBSTATS
*
* @param startTime
* @return
*/
public List<CoffeeTableRow> DBReadStats(long startTime);
/**
* Table category: DBPOLLS
*
* @param name
* @param player
* @param subject
* @param description
* @param optionXML
* @param flag
* @param qualZapper
* @param results
* @param expiration
*/
public void DBCreatePoll(String name, String player, String subject, String description, String optionXML,
int flag, String qualZapper, String results, long expiration);
/**
* Table category: DBPOLLS
*
* @param OldName
* @param name
* @param player
* @param subject
* @param description
* @param optionXML
* @param flag
* @param qualZapper
* @param results
* @param expiration
*/
public void DBUpdatePoll(String OldName, String name, String player, String subject, String description,
String optionXML, int flag, String qualZapper, String results, long expiration);
/**
* Table category: DBPOLLS
*
* @param name
* @param results
*/
public void DBUpdatePollResults(String name, String results);
/**
* Table category: DBPOLLS
*
* @param name
*/
public void DBDeletePoll(String name);
/**
* Table category: DBPOLLS
*
* @return
*/
public List<PollData> DBReadPollList();
/**
* Table category: DBPOLLS
*
* @param name
* @return
*/
public PollData DBReadPoll(String name);
/**
* Table category: DBVFS
*
* @return
*/
public CMFile.CMVFSDir DBReadVFSDirectory();
/**
* Table category: DBVFS
*
* @param filename
* @return
*/
public CMFile.CMVFSFile DBReadVFSFile(String filename);
/**
* Table category: DBVFS
*
* @param filename
* @param bits
* @param creator
* @param updateTime
* @param data
*/
public void DBCreateVFSFile(String filename, int bits, String creator, long updateTime, Object data);
/**
* Table category: DBVFS
*
* @param filename
* @param bits
* @param creator
* @param updateTime
* @param data
*/
public void DBUpSertVFSFile(String filename, int bits, String creator, long updateTime, Object data);
/**
* Table category: DBVFS
*
* @param filename
*/
public void DBDeleteVFSFile(String filename);
/**
* Table category: DBBACKLOG
*
* @param channelName
* @param entry
*/
public void addBackLogEntry(String channelName, final String entry);
/**
* Table category: DBBACKLOG
*
* @param channelName
* @param newestToSkip
* @param numToReturn
* @return
*/
public List<Pair<String,Long>> getBackLogEntries(String channelName, final int newestToSkip, final int numToReturn);
/**
* Table category: DBBACKLOG
*
* @param channels
* @param maxMessages
* @param oldestTime
*/
public void trimBackLogEntries(final String[] channels, final int maxMessages, final long oldestTime);
/**
* Table category: DBPLAYERDATA
*
* @author Bo Zimmerman
*
*/
public static interface PlayerData
{
/**
*
* @return
*/
public String who();
/**
*
* @param who
* @return
*/
public PlayerData who(String who);
/**
*
* @return
*/
public String section();
/**
*
* @param section
* @return
*/
public PlayerData section(String section);
/**
*
* @return
*/
public String key();
/**
*
* @param key
* @return
*/
public PlayerData key(String key);
/**
*
* @return
*/
public String xml();
/**
*
* @param xml
* @return
*/
public PlayerData xml(String xml);
}
/**
* Table category: DBPOLLS
*
* @author Bo Zimmerman
*
*/
public static interface PollData
{
/**
*
* @return
*/
public String name();
/**
*
* @return
*/
public long flag();
/**
*
* @return
*/
public String byName();
/**
*
* @return
*/
public String subject();
/**
*
* @return
*/
public String description();
/**
*
* @return
*/
public String options();
/**
*
* @return
*/
public String qual();
/**
*
* @return
*/
public String results();
/**
*
* @return
*/
public long expiration();
}
/**
* Table category: DBRACE, DBCHARCLASS, DBABILITY
*
* @author Bo Zimmerman
*
*/
public static interface AckRecord
{
/**
*
* @return
*/
public String ID();
/**
*
* @return
*/
public String data();
/**
*
* @return
*/
public String typeClass();
}
}
