Package org.apache.wiki.forms

Class FormInfo

  • All Implemented Interfaces:
    java.io.Serializable
    public class FormInfo
extends java.lang.Object
implements java.io.Serializable
    Container for carrying HTTP FORM information between Plugin invocations in the Session.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ERROR
      State: There was an error.
      static int EXECUTED
      State: Form is executed.
      static int OK
      State: Form is OK.

    • Constructor Summary

      Constructors 
      Constructor Description
      FormInfo()
      Creates a new FormInfo with status == OK.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addSubmission​(java.util.Map<java.lang.String,​java.lang.String> val)
      Adds the given values into the handler parameter map.
      java.lang.String getAction()
      Get the action set in setAction(String).
      java.lang.String getError()
      Return the error.
      java.lang.String getHandler()
      Return the name of the handler class.
      java.lang.String getName()
      Return the name of the form.
      java.lang.String getResult()
      Return the result.
      int getStatus()
      Return the status.
      java.util.Map<java.lang.String,​java.lang.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​(java.lang.String val)
      Set the value of the action parameter.
      void setError​(java.lang.String val)
      Set an error string.
      void setHandler​(java.lang.String val)
      Set the name of the handler class.
      void setHide​(boolean val)
      Set the hide parameter.
      void setName​(java.lang.String val)
      Sets the name of the form.
      void setResult​(java.lang.String val)
      Set the result.
      void setStatus​(int val)
      Set the status of the Form processing.
      void setSubmission​(java.util.Map<java.lang.String,​java.lang.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

    • Constructor Detail

      • FormInfo

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

    • Method Detail

      • 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​(java.lang.String val)
        Set the value of the action parameter.
        Parameters:
        val - A value parameter.

      • setName

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

      • getName

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

      • setHandler

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

      • getHandler

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

      • setResult

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

      • getResult

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

      • setError

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

      • getError

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

      • setSubmission

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

      • getSubmission

        public java.util.Map<java.lang.String,​java.lang.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.