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

Nested Class Summary

static interface	JournalsLibrary.CommandJournal
static class	JournalsLibrary.CommandJournalFlags
static interface	JournalsLibrary.ForumJournal
static class	JournalsLibrary.ForumJournalFlags
static interface	JournalsLibrary.JournalMetaData
static interface	JournalsLibrary.MsgMkrCallback
static class	JournalsLibrary.MsgMkrResolution
static interface	JournalsLibrary.SMTPJournal

Field Summary

static java.lang.String

JOURNAL_BOUNDARY

Method Summary

boolean	canReadMessage(JournalEntry entry, java.lang.String srchMatch, MOB readerM, boolean ignorePrivileges)
void	clearJournalSummaryStats(JournalsLibrary.ForumJournal journal)
java.util.Enumeration<JournalsLibrary.CommandJournal>	commandJournals()
java.util.Enumeration<JournalsLibrary.ForumJournal>	forumJournals()
java.util.Set<java.lang.String>	getArchonJournalNames()
java.util.List<JournalsLibrary.ForumJournal>	getClanForums(Clan clan)
JournalsLibrary.CommandJournal	getCommandJournal(java.lang.String named)
JournalsLibrary.ForumJournal	getForumJournal(java.lang.String named)
JournalsLibrary.ForumJournal	getForumJournal(java.lang.String named, Clan clan)
JournalsLibrary.JournalMetaData	getJournalStats(JournalsLibrary.ForumJournal journal)
int	getNumCommandJournals()
int	getNumForumJournals()
java.lang.String	getScriptValue(MOB mob, java.lang.String journal, java.lang.String oldValue)
boolean	isArchonJournalName(java.lang.String journal)
int	loadCommandJournals(java.lang.String list)
int	loadForumJournals(java.lang.String list)
JournalsLibrary.MsgMkrResolution	makeMessage(MOB mob, java.lang.String messageTitle, java.util.List<java.lang.String> vbuf, boolean autoAdd)
void	makeMessageASync(MOB mob, java.lang.String messageTitle, java.util.List<java.lang.String> vbuf, boolean autoAdd, JournalsLibrary.MsgMkrCallback back)
void	registerClanForum(Clan clan, java.lang.String allClanForumMappings)
boolean	subscribeToJournal(java.lang.String journalName, java.lang.String userName, boolean saveMailingList)
boolean	unsubscribeFromJournal(java.lang.String journalName, java.lang.String userName, boolean saveMailingList)

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

See Also:

Constant Field Values

Method Detail

getArchonJournalNames

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

isArchonJournalName

boolean isArchonJournalName(java.lang.String journal)

loadCommandJournals

int loadCommandJournals(java.lang.String list)

commandJournals

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

getCommandJournal

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

getNumCommandJournals

int getNumCommandJournals()

getScriptValue

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

canReadMessage

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

loadForumJournals

int loadForumJournals(java.lang.String list)

forumJournals

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

getForumJournal

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

getForumJournal

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

getNumForumJournals

int getNumForumJournals()

registerClanForum

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

getClanForums

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

subscribeToJournal

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

unsubscribeFromJournal

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

getJournalStats

JournalsLibrary.JournalMetaData getJournalStats(JournalsLibrary.ForumJournal journal)

clearJournalSummaryStats

void clearJournalSummaryStats(JournalsLibrary.ForumJournal journal)

makeMessage

JournalsLibrary.MsgMkrResolution makeMessage(MOB mob,
                                             java.lang.String messageTitle,
                                             java.util.List<java.lang.String> vbuf,
                                             boolean autoAdd)
                                             throws java.io.IOException

Throws:

java.io.IOException

makeMessageASync

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