This project has retired. For details please refer to its Attic page.

org.apache.cocoon.forms.acting
Class HandleFormSubmitAction

java.lang.Object
  org.apache.cocoon.forms.acting.AbstractFormsAction
      org.apache.cocoon.forms.acting.HandleFormSubmitAction

All Implemented Interfaces:

Disposable, Component, Serviceable, ThreadSafe, Action

public class HandleFormSubmitAction
extends AbstractFormsAction

An action that will create a form instance, let it handle the current request (and do validation), and will return not-null if validation was successfully or null when validation failed. In both cases, the created form instance is stored in a request attribute, so that it can be picked up later on by other components.

Required parameters:

• form-definition: filename (URL) pointing to the form definition file
• attribute-name: name of the request attribute in which the form instance should be stored

Version:

$Id: HandleFormSubmitAction.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary

Fields inherited from class org.apache.cocoon.forms.acting.AbstractFormsAction

formManager, manager

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

HandleFormSubmitAction()

Method Summary

Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String src, Parameters parameters) Controls the processing against some values of the Dictionary objectModel and returns a Map object with values used in subsequent sitemap substitution patterns.

Methods inherited from class org.apache.cocoon.forms.acting.AbstractFormsAction

dispose, service

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HandleFormSubmitAction

public HandleFormSubmitAction()

Method Detail

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String src,
               Parameters parameters)
        throws Exception

Description copied from interface: Action

Controls the processing against some values of the Dictionary objectModel and returns a Map object with values used in subsequent sitemap substitution patterns. NOTE: This interface is designed so that implentations can be ThreadSafe. When an action is ThreadSafe, only one instance serves all requests : this reduces memory usage and avoids pooling.

resolver - The SourceResolver in charge

objectModel - The Map with object of the calling environment which can be used to select values this controller may need (ie Request, Response).

src - A source String to the Action

parameters - The Parameters for this invocation

Returns:

Map The returned Map object with sitemap substitution values which can be used in subsequent elements attributes like src= using a xpath like expression: src="mydir/{myval}/foo" If the return value is null the processing inside the element of the sitemap will be skipped.

Throws:

Exception - Indicates something is totally wrong