Package org.apache.wiki.forms

Class FormInfo

java.lang.Object
org.apache.wiki.forms.FormInfo
All Implemented Interfaces:
Serializable
public class FormInfo extends Object implements Serializable
Container for carrying HTTP FORM information between Plugin invocations in the Session.
See Also:

  • Field Details

  • Constructor Details

    • FormInfo

      public FormInfo()
      Creates a new FormInfo with status == OK.

  • Method Details

    • setStatus

      public void setStatus(int val)
      Set the status of the Form processing.
      Parameters:
      val - EXECUTED, OK or ERROR.

    • getStatus

      public int getStatus()
      Return the status.
      Returns:
      The status.

    • setHide

      public void setHide(boolean val)
      Set the hide parameter.
      Parameters:
      val - True or false.

    • hide

      public boolean hide()
      Returns true, if the form is supposed to be hidden.
      Returns:
      True or false.

    • setAction

      public void setAction(String val)
      Set the value of the action parameter.
      Parameters:
      val - A value parameter.

    • getAction

      public String getAction()
      Get the action set in setAction(String).
      Returns:
      An Action.

    • setName

      public void setName(String val)
      Sets the name of the form.
      Parameters:
      val - The name of the form.

    • getName

      public String getName()
      Return the name of the form.
      Returns:
      The name of the form.

    • setHandler

      public void setHandler(String val)
      Set the name of the handler class.
      Parameters:
      val - The name of the class.

    • getHandler

      public String getHandler()
      Return the name of the handler class.
      Returns:
      The name of the class.

    • setResult

      public void setResult(String val)
      Set the result.
      Parameters:
      val - The result.

    • getResult

      public String getResult()
      Return the result.
      Returns:
      The result.

    • setError

      public void setError(String val)
      Set an error string.
      Parameters:
      val - An error string.

    • getError

      public String getError()
      Return the error.
      Returns:
      The error.

    • setSubmission

      public void setSubmission(Map<String,String> 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<String,String> val)
      Adds the given values into the handler parameter map.
      Parameters:
      val - parameter name-value pairs for a Form handler WikiPlugin

    • getSubmission

      public Map<String,String> 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.