com.ecyrd.jspwiki.plugin
Class VotePlugin

java.lang.Object
  extended by com.ecyrd.jspwiki.plugin.VotePlugin
All Implemented Interfaces:
WikiPlugin

public class VotePlugin
extends Object
implements WikiPlugin

Implements a simple voting system. WARNING: The storage method is still experimental; I will probably change it at some point.


Field Summary
static String ATTACHMENT_NAME
           
static String VAR_VOTES
           
 
Constructor Summary
VotePlugin()
           
 
Method Summary
 String execute(WikiContext context, Map params)
          This is the main entry point for any plugin.
 int vote(WikiContext context, int vote)
          +1 for yes, -1 for no.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATTACHMENT_NAME

public static String ATTACHMENT_NAME

VAR_VOTES

public static String VAR_VOTES
Constructor Detail

VotePlugin

public VotePlugin()
Method Detail

vote

public int vote(WikiContext context,
                int vote)
+1 for yes, -1 for no.

Returns:
number of votes, or -1 if an error occurred.

execute

public String execute(WikiContext context,
                      Map params)
               throws PluginException
Description copied from interface: WikiPlugin
This is the main entry point for any plugin. The parameters are parsed, and a special parameter called "_body" signifies the name of the plugin body, i.e. the part of the plugin that is not a parameter of the form "key=value". This has been separated using an empty line.

Note that it is preferred that the plugin returns XHTML-compliant HTML (i.e. close all tags, use <br /> instead of <br>, etc.

Specified by:
execute in interface WikiPlugin
Parameters:
context - The current WikiContext.
params - A Map which contains key-value pairs. Any parameter that the user has specified on the wiki page will contain String-String parameters, but it is possible that at some future date, JSPWiki will give you other things that are not Strings.
Returns:
HTML, ready to be included into the rendered page.
Throws:
PluginException - In case anything goes wrong.