com.planet_ink.coffee_mud.Libraries.interfaces
Interface JournalsLibrary

All Superinterfaces:
java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>, java.lang.Runnable
All Known Implementing Classes:
CMJournals

public interface JournalsLibrary
extends CMLibrary, java.lang.Runnable


Nested Class Summary
static class JournalsLibrary.CommandJournal
           
static class JournalsLibrary.CommandJournalFlags
           
static class JournalsLibrary.ForumJournal
           
static class JournalsLibrary.ForumJournalFlags
           
static class JournalsLibrary.JournalEntry
           
static class JournalsLibrary.JournalSummaryStats
           
 
Field Summary
static java.lang.String JOURNAL_BOUNDARY
           
 
Method Summary
 boolean canReadMessage(JournalsLibrary.JournalEntry entry, java.lang.String srchMatch, MOB readerM, boolean ignorePrivileges)
           
 void clearJournalSummaryStats(java.lang.String journalName)
           
 java.util.Enumeration<JournalsLibrary.CommandJournal> commandJournals()
           
 java.util.Enumeration<JournalsLibrary.ForumJournal> forumJournals()
           
 java.util.HashSet<java.lang.String> getArchonJournalNames()
           
 JournalsLibrary.CommandJournal getCommandJournal(java.lang.String named)
           
 JournalsLibrary.ForumJournal getForumJournal(java.lang.String named)
           
 JournalsLibrary.JournalSummaryStats getJournalStats(java.lang.String journalName)
           
 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)
           
 
Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary
activate, getSupportThread, propertiesLoaded, shutdown
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, ID, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface java.lang.Runnable
run
 

Field Detail

JOURNAL_BOUNDARY

static final java.lang.String JOURNAL_BOUNDARY
See Also:
Constant Field Values
Method Detail

getArchonJournalNames

java.util.HashSet<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(JournalsLibrary.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)

getNumForumJournals

int getNumForumJournals()

getJournalStats

JournalsLibrary.JournalSummaryStats getJournalStats(java.lang.String journalName)

clearJournalSummaryStats

void clearJournalSummaryStats(java.lang.String journalName)