Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface JournalsLibrary

All Superinterfaces:

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

All Known Implementing Classes:

CMJournals

public interface JournalsLibrary
extends CMLibrary

Journals are any set of ordered messages, threaded or unthreaded, which are stored in a database and divided into categories, called Journals or Forums. Journals are the common name when talking about readable message items and certain system journals (Command Journals), such as BUGS. Forums the term used when a journal is available from a web page.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	JournalsLibrary.CommandJournal	Command Journals are another category of Journal that is accessed from the command line (as oppposed to SMTP Journals accessed via email, Forums accessed via web page, and standard Journal accessed via item).
static class	JournalsLibrary.CommandJournalFlags	This enum defines flags that apply to command journals.
static interface	JournalsLibrary.ForumJournal	Journals with a meta-flags entry, typically Forums, are described by the accessors of this interface.
static class	JournalsLibrary.ForumJournalFlags	Journals with a meta-flags entry, typically Forums, have numerous flags that define them.
static interface	JournalsLibrary.JournalMetaData	ForumJournals are journals accessed via the web, and are typically threaded in their messages.
static interface	JournalsLibrary.MsgMkrCallback	Since The Message Maker advanced cl editor is async, this interface exists to provide a callBack to the message maker.
static class	JournalsLibrary.MsgMkrResolution	The return value of the resolution of the message maker closing.
static interface	JournalsLibrary.SMTPJournal	An accessor interface for a view of a journal that is exposed to an email system.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	JOURNAL_BOUNDARY	Non-Forum journal messages handle "replies" by tacking them to the end of the main message.

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

idConverter

Method Summary

Modifier and Type	Method	Description
boolean	canReadMessage(JournalEntry entry, java.lang.String srchMatch, MOB readerM, boolean ignorePrivileges)	A security checker for whether the given user can read the given message.
void	clearJournalSummaryStats(JournalsLibrary.ForumJournal journal)	Clears the forum journal summary stats so that they can be rebuilt from the database.
java.util.Enumeration<JournalsLibrary.CommandJournal>	commandJournals()	Returns an enumeration of all registered command journals
java.util.Enumeration<JournalsLibrary.ForumJournal>	forumJournals()	Returns an enumeration of all normal forumJournals (not clan ones).
java.util.Enumeration<JournalsLibrary.ForumJournal>	forumJournalsSorted()	Returns an enumeration of all normal ForumJournals (not clan ones), sorted by somehow.
java.util.Set<java.lang.String>	getArchonJournalNames()	Returns the cached set of basic items that implement the ArchonOnly interface, thus making them ArchonOnly journals.
java.util.List<JournalsLibrary.ForumJournal>	getClanForums(Clan clan)	Returns the list of ForumJournals that exist for the given clan.
JournalsLibrary.CommandJournal	getCommandJournal(java.lang.String named)	Returns the information about the Command Journal of the given name.
JournalsLibrary.ForumJournal	getForumJournal(java.lang.String named)	Returns a ForumJournal of the given name.
JournalsLibrary.ForumJournal	getForumJournal(java.lang.String named, Clan clan)	Retreives a specific forum journal given to a particular clan.
JournalsLibrary.JournalMetaData	getJournalStats(JournalsLibrary.ForumJournal journal)	Get the forum journal summary stats, caching them after calculation from the database
int	getNumCommandJournals()	Returns the number of command journals, or journals written to using standard game commands.
int	getNumForumJournals()	Returns the number of forum journals.
java.lang.String	getScriptValue(MOB mob, java.lang.String journal, java.lang.String oldValue)	If the given journal requires running a MOBPROG script in order to produce a final message, this function will run that script.
boolean	isArchonJournalName(java.lang.String journal)	Returns whether the given journal appears on the archon journal names list.
int	loadCommandJournals(java.lang.String list)	Given an encoded journals list string, this function will register all the CommandJournals described by the encoded list string.
int	loadForumJournals(java.lang.String list)	Loads the forumjournals from the given encoded forum definition string.
void	makeMessageASync(MOB mob, java.lang.String messageTitle, java.util.List<java.lang.String> vbuf, boolean autoAdd, JournalsLibrary.MsgMkrCallback back)	An asynchronous system for allowing a user to edit a text document with options for search and replace, line inserting and deleting, and line replacement.
void	notifyPosting(java.lang.String journal, java.lang.String from, java.lang.String to, java.lang.String subject)	Whenever a post to a journal is made, this function is called to send a notification to online users who have subscribed to such things.
void	notifyReplying(java.lang.String journal, java.lang.String tpAuthor, java.lang.String reAuthor, java.lang.String subject)	Whenever a reply to a journal is made, this function is called to send a notification to online users who have subscribed to such things.
void	registerClanForum(Clan clan, java.lang.String allClanForumMappings)	Registers a set of ForumJournals for the given clan from the coded string.
void	resetCalendarEvents()	Since Calendar events are also journal entries, whenever the calendar is changed, this method must be called to make sure notifications for new events occurs.
boolean	subscribeToJournal(java.lang.String journalName, java.lang.String userName, boolean saveMailingList)	Called to add a user to the subscription list for a journal.
boolean	unsubscribeFromAll(java.lang.String username)	Unsubscribes the given user/account from every mailing list.
boolean	unsubscribeFromJournal(java.lang.String journalName, java.lang.String userName, boolean saveMailingList)	Called to remove a user from the subscription list for a journal.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

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

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

JOURNAL_BOUNDARY

static final java.lang.String JOURNAL_BOUNDARY

Non-Forum journal messages handle "replies" by tacking them to the end of the main message. This is the official boundary.

See Also:

Constant Field Values

Method Detail

getArchonJournalNames

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

Returns the cached set of basic items that implement the ArchonOnly interface, thus making them ArchonOnly journals.

Returns:

the set of journal names

See Also:

isArchonJournalName(String), ArchonOnly

isArchonJournalName

boolean isArchonJournalName(java.lang.String journal)

Returns whether the given journal appears on the archon journal names list.

Parameters:

journal - the journal name

Returns:

true if its an archon only item name, false otherwise

See Also:

getArchonJournalNames(), ArchonOnly

loadCommandJournals

int loadCommandJournals(java.lang.String list)

Given an encoded journals list string, this function will register all the CommandJournals described by the encoded list string. See coffeemud.ini file for the format.

Parameters:

list - the coded string

Returns:

the number of command journals loaded

See Also:

JournalsLibrary.CommandJournal, commandJournals(), getCommandJournal(String), getNumCommandJournals()

commandJournals

java.util.Enumeration<JournalsLibrary.CommandJournal> commandJournals()

Returns an enumeration of all registered command journals

Returns:

the command journals

See Also:

JournalsLibrary.CommandJournal, loadCommandJournals(String), getCommandJournal(String), getNumCommandJournals()

getCommandJournal

JournalsLibrary.CommandJournal getCommandJournal(java.lang.String named)

Returns the information about the Command Journal of the given name.

Parameters:

named - the command journal name

Returns:

null, or the journal info object

See Also:

JournalsLibrary.CommandJournal, loadCommandJournals(String), commandJournals(), getNumCommandJournals()

getNumCommandJournals

int getNumCommandJournals()

Returns the number of command journals, or journals written to using standard game commands.

Returns:

the number of command journals loaded

See Also:

JournalsLibrary.CommandJournal, loadCommandJournals(String), commandJournals(), getCommandJournal(String)

getScriptValue

java.lang.String getScriptValue(MOB mob,
                                java.lang.String journal,
                                java.lang.String oldValue)

If the given journal requires running a MOBPROG script in order to produce a final message, this function will run that script.

Parameters:

mob - the player trying to post to the journal

journal - the journal that might be scripted

oldValue - the value entered before the scripting

Returns:

the final value, typically just the oldValue

canReadMessage

boolean canReadMessage(JournalEntry entry,
                       java.lang.String srchMatch,
                       MOB readerM,
                       boolean ignorePrivileges)

A security checker for whether the given user can read the given message. Applies a myriad of rules that can be controlled from the arguments.

Parameters:

entry - the journal entry

srchMatch - null, or a string to match almost anything in the entry

readerM - null, or the reader of the message

ignorePrivileges - true to NOT require JOURNAL secflag, false to require it

Returns:

true if the message can be read

loadForumJournals

int loadForumJournals(java.lang.String list)

Loads the forumjournals from the given encoded forum definition string. See the coffeemud.ini file for the format of this string.

Parameters:

list - the coded string

Returns:

the number of forum journals loaded

See Also:

getNumForumJournals(), forumJournals(), forumJournalsSorted(), getForumJournal(String), getForumJournal(String, Clan)

forumJournals

java.util.Enumeration<JournalsLibrary.ForumJournal> forumJournals()

Returns an enumeration of all normal forumJournals (not clan ones). Unsorted for speed.

Returns:

the forumjournals

See Also:

getNumForumJournals(), forumJournalsSorted(), getForumJournal(String), getForumJournal(String, Clan), loadForumJournals(String)

forumJournalsSorted

java.util.Enumeration<JournalsLibrary.ForumJournal> forumJournalsSorted()

Returns an enumeration of all normal ForumJournals (not clan ones), sorted by somehow.

Returns:

the sorted forums

See Also:

getNumForumJournals(), forumJournals(), getForumJournal(String), getForumJournal(String, Clan), loadForumJournals(String)

getForumJournal

JournalsLibrary.ForumJournal getForumJournal(java.lang.String named)

Returns a ForumJournal of the given name.

Parameters:

named - the name of the forumjournal

Returns:

the ForumJournal object

See Also:

getNumForumJournals(), forumJournals(), forumJournalsSorted(), getForumJournal(String, Clan), loadForumJournals(String)

getForumJournal

JournalsLibrary.ForumJournal getForumJournal(java.lang.String named,
                                             Clan clan)

Retreives a specific forum journal given to a particular clan.

Parameters:

named - the name of the journal

clan - the clan to whom the journal belongs

Returns:

null, or the forumjournal

See Also:

getNumForumJournals(), forumJournals(), forumJournalsSorted(), getForumJournal(String), loadForumJournals(String)

getNumForumJournals

int getNumForumJournals()

Returns the number of forum journals.

Returns:

the number of forum journals.

See Also:

forumJournals(), forumJournalsSorted(), getForumJournal(String), getForumJournal(String, Clan), loadForumJournals(String)

registerClanForum

void registerClanForum(Clan clan,
                       java.lang.String allClanForumMappings)

Registers a set of ForumJournals for the given clan from the coded string. See the coffeemud.ini file for the format of this string.

Parameters:

clan - the clan

allClanForumMappings - the coded string

See Also:

getClanForums(Clan)

getClanForums

java.util.List<JournalsLibrary.ForumJournal> getClanForums(Clan clan)

Returns the list of ForumJournals that exist for the given clan.

Parameters:

clan - the clan

Returns:

the list of ForumJournals for this clan

See Also:

registerClanForum(Clan, String)

subscribeToJournal

boolean subscribeToJournal(java.lang.String journalName,
                           java.lang.String userName,
                           boolean saveMailingList)

Called to add a user to the subscription list for a journal.

Parameters:

journalName - the name of the journal

userName - the user who subscribed

saveMailingList - true to save afterwards, false if you'll do it later

Returns:

true if someone was added, false otherwise

unsubscribeFromAll

boolean unsubscribeFromAll(java.lang.String username)

Unsubscribes the given user/account from every mailing list.

Parameters:

username - the user/account

Returns:

true if an unsubscribe happened

unsubscribeFromJournal

boolean unsubscribeFromJournal(java.lang.String journalName,
                               java.lang.String userName,
                               boolean saveMailingList)

Called to remove a user from the subscription list for a journal.

Parameters:

journalName - the name of the journal

userName - the user who subscribed

saveMailingList - true to save afterwards, false if you'll do it later

Returns:

true if someone was removed, false otherwise

getJournalStats

JournalsLibrary.JournalMetaData getJournalStats(JournalsLibrary.ForumJournal journal)

Get the forum journal summary stats, caching them after calculation from the database

Parameters:

journal - the journal

Returns:

the stats

See Also:

JournalsLibrary.JournalMetaData

clearJournalSummaryStats

void clearJournalSummaryStats(JournalsLibrary.ForumJournal journal)

Clears the forum journal summary stats so that they can be rebuilt from the database.

Parameters:

journal - the journal that needs updating

See Also:

JournalsLibrary.JournalMetaData

notifyPosting

void notifyPosting(java.lang.String journal,
                   java.lang.String from,
                   java.lang.String to,
                   java.lang.String subject)

Whenever a post to a journal is made, this function is called to send a notification to online users who have subscribed to such things.

Parameters:

journal - the journal posted at

from - the author of the message posted

to - who the post is too

subject - the subject of the top message

notifyReplying

void notifyReplying(java.lang.String journal,
                    java.lang.String tpAuthor,
                    java.lang.String reAuthor,
                    java.lang.String subject)

Whenever a reply to a journal is made, this function is called to send a notification to online users who have subscribed to such things.

Parameters:

journal - the journal replied at

tpAuthor - the author of the message replied to

reAuthor - the author of the reply

subject - the subject of the top message

makeMessageASync

void makeMessageASync(MOB mob,
                      java.lang.String messageTitle,
                      java.util.List<java.lang.String> vbuf,
                      boolean autoAdd,
                      JournalsLibrary.MsgMkrCallback back)

An asynchronous system for allowing a user to edit a text document with options for search and replace, line inserting and deleting, and line replacement. A save option is also provided.

Parameters:

mob - the player doing the editing

messageTitle - the title of the message

vbuf - the text of the message

autoAdd - true to go directly into line adding mode, false to start in menu

back - the callBack when done

See Also:

JournalsLibrary.MsgMkrCallback, JournalsLibrary.MsgMkrResolution

resetCalendarEvents

void resetCalendarEvents()

Since Calendar events are also journal entries, whenever the calendar is changed, this method must be called to make sure notifications for new events occurs.