|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.wiki.forms.FormInfo
public class FormInfo
Container for carrying HTTP FORM information between WikiPlugin invocations in the Session.
Field Summary | |
---|---|
static int |
ERROR
State: There was an error. |
static int |
EXECUTED
State: Form is executed. |
static int |
OK
State: Form is OK. |
Constructor Summary | |
---|---|
FormInfo()
Creates a new FormInfo with status == OK. |
Method Summary | |
---|---|
void |
addSubmission(Map<String,String> val)
Adds the given values into the handler parameter map. |
String |
getAction()
Get the action set in setAction(String) . |
String |
getError()
Return the error. |
String |
getHandler()
Return the name of the handler class. |
String |
getName()
Return the name of the form. |
String |
getResult()
Return the result. |
int |
getStatus()
Return the status. |
Map<String,String> |
getSubmission()
Returns parameter name-value pairs for a Form handler WikiPlugin. |
boolean |
hide()
Returns true, if the form is supposed to be hidden. |
void |
setAction(String val)
Set the value of the action parameter. |
void |
setError(String val)
Set an error string. |
void |
setHandler(String val)
Set the name of the handler class. |
void |
setHide(boolean val)
Set the hide parameter. |
void |
setName(String val)
Sets the name of the form. |
void |
setResult(String val)
Set the result. |
void |
setStatus(int val)
Set the status of the Form processing. |
void |
setSubmission(Map<String,String> 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 |
---|
public static final int EXECUTED
public static final int OK
public static final int ERROR
Constructor Detail |
---|
public FormInfo()
Method Detail |
---|
public void setStatus(int val)
val
- EXECUTED, OK or ERROR.public int getStatus()
public void setHide(boolean val)
val
- True or false.public boolean hide()
public void setAction(String val)
val
- A value parameter.public String getAction()
setAction(String)
.
public void setName(String val)
val
- The name of the form.public String getName()
public void setHandler(String val)
val
- The name of the class.public String getHandler()
public void setResult(String val)
val
- The result.public String getResult()
public void setError(String val)
val
- An error string.public String getError()
public void setSubmission(Map<String,String> val)
val
- parameter name-value pairs for a Form handler WikiPluginpublic void addSubmission(Map<String,String> val)
val
- parameter name-value pairs for a Form handler WikiPluginpublic Map<String,String> getSubmission()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |