com.ecyrd.jspwiki.forms
Class FormInfo

java.lang.Object
  extended by com.ecyrd.jspwiki.forms.FormInfo
All Implemented Interfaces:
Serializable

public class FormInfo
extends Object
implements Serializable

Container for carrying HTTP FORM information between WikiPlugin invocations in the Session.

Author:
ebu
See Also:
Serialized Form

Field Summary
 String action
           
 String error
           
static int ERROR
           
static int EXECUTED
           
 String handler
           
 boolean hide
           
 String name
           
static int OK
           
 String result
           
 int status
           
 Map submission
           
 
Constructor Summary
FormInfo()
           
 
Method Summary
 void addSubmission(Map val)
          Adds the given values into the handler parameter map.
 String getAction()
           
 String getError()
           
 String getHandler()
           
 String getName()
           
 String getResult()
           
 int getStatus()
           
 Map getSubmission()
          Returns parameter name-value pairs for a Form handler WikiPlugin.
 boolean hide()
           
 void setAction(String val)
           
 void setError(String val)
           
 void setHandler(String val)
           
 void setHide(boolean val)
           
 void setName(String val)
           
 void setResult(String val)
           
 void setStatus(int val)
           
 void setSubmission(Map val)
          Copies the given values into the handler parameter map using Map.putAll().
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EXECUTED

public static final int EXECUTED
See Also:
Constant Field Values

OK

public static final int OK
See Also:
Constant Field Values

ERROR

public static final int ERROR
See Also:
Constant Field Values

status

public int status

hide

public boolean hide

action

public String action

name

public String name

handler

public String handler

result

public String result

error

public String error

submission

public Map submission
Constructor Detail

FormInfo

public FormInfo()
Method Detail

setStatus

public void setStatus(int val)

getStatus

public int getStatus()

setHide

public void setHide(boolean val)

hide

public boolean hide()

setAction

public void setAction(String val)

getAction

public String getAction()

setName

public void setName(String val)

getName

public String getName()

setHandler

public void setHandler(String val)

getHandler

public String getHandler()

setResult

public void setResult(String val)

getResult

public String getResult()

setError

public void setError(String val)

getError

public String getError()

setSubmission

public void setSubmission(Map val)
Copies the given values into the handler parameter map using Map.putAll().

Parameters:
val - parameter name-value pairs for a Form handler WikiPlugin

addSubmission

public void addSubmission(Map val)
Adds the given values into the handler parameter map.

Parameters:
val - parameter name-value pairs for a Form handler WikiPlugin

getSubmission

public Map getSubmission()
Returns parameter name-value pairs for a Form handler WikiPlugin. The names are those of Form input fields, and the values whatever the user selected in the form. The FormSet plugin can also be used to provide initial values.

Returns:
Handler parameter name-value pairs.