Package com.planet_ink.coffee_mud.WebMacros

Class JournalInfo

java.lang.Object

com.planet_ink.coffee_mud.WebMacros.StdWebMacro

com.planet_ink.coffee_mud.WebMacros.JournalInfo

All Implemented Interfaces:

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

public class JournalInfo
extends StdWebMacro

Field Summary

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

idConverter

Constructor Summary

Constructors

Constructor	Description
JournalInfo()

Method Summary

Modifier and Type	Method	Description
static void	clearJournalCache(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String journalName)
static JournalEntry	getEntry(java.util.List<JournalEntry> msgs, java.lang.String key)
static java.util.List<JournalEntry>	getMessages(java.lang.String journalName, JournalsLibrary.ForumJournal forumJournal, java.lang.String page, java.lang.String mpage, java.lang.String parent, java.lang.String dbsearch, int msgLimit, java.util.Map<java.lang.String,java.lang.Object> objs)
static JournalEntry	getNextEntry(java.util.List<JournalEntry> info, java.lang.String key)
java.lang.String	name()	The public name of this macro
java.lang.String	runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String parm, com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp)	This method is executed only if this macro returns false for preferBinary().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.WebMacros.StdWebMacro

clearWebMacros, clearWebMacros, colorwebifyOnly, compareTo, copyOf, getHTTPFileData, grabFile, helpHelp, helpHelp, htmlIncomingFilter, htmlIncomingFilter, htmlOutgoingFilter, htmlOutgoingFilter, ID, initializeClass, isAdminMacro, isAWebPath, L, newInstance, parseOrderedParms, parseParms, parseParms, preferBinary, runBinaryMacro, safeIncomingfilter, webify, webify

Constructor Detail

JournalInfo

public JournalInfo()

Method Detail

name

public java.lang.String name()

Description copied from interface: WebMacro

The public name of this macro

Specified by:

name in interface CMObject

Specified by:

name in interface WebMacro

Overrides:

name in class StdWebMacro

Returns:

The public name of this macro

See Also:

Environmental.Name()

getEntry

public static JournalEntry getEntry(java.util.List<JournalEntry> msgs,
                                    java.lang.String key)

getMessages

public static java.util.List<JournalEntry> getMessages(java.lang.String journalName,
                                                       JournalsLibrary.ForumJournal forumJournal,
                                                       java.lang.String page,
                                                       java.lang.String mpage,
                                                       java.lang.String parent,
                                                       java.lang.String dbsearch,
                                                       int msgLimit,
                                                       java.util.Map<java.lang.String,java.lang.Object> objs)

clearJournalCache

public static void clearJournalCache(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                     java.lang.String journalName)

getNextEntry

public static JournalEntry getNextEntry(java.util.List<JournalEntry> info,
                                        java.lang.String key)

runMacro

public java.lang.String runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                 java.lang.String parm,
                                 com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp)

Description copied from interface: WebMacro

This method is executed only if this macro returns false for preferBinary(). It will execute the macro and return its results as a string, which is then substituted for the macro reference in the web page where the macro was found. The response object is used to set cookies and headers only. Any response body is in the return object. Since 99% of macros are only filling in an existing page, nothing will be done with that anyway, and is only important when isAWebPath return true.

Specified by:

runMacro in interface WebMacro

Overrides:

runMacro in class StdWebMacro

Parameters:

httpReq - the external requests object

parm - any parameter strings given to the macro

httpResp - the response, with headers

Returns:

the string result of running this macro

See Also:

WebMacro.preferBinary(), HTTPRequest