org.apache.cocoon.forms.acting
Class MakeFormAction

java.lang.Object
  org.apache.cocoon.forms.acting.MakeFormAction

All Implemented Interfaces:

Component, Serviceable, ThreadSafe, Action

public class MakeFormAction
extends Object
implements Action, ThreadSafe, Serviceable

An action that creates a new form instance and stores it in a request attribute.

Required parameters:

• form-definition: filename (URL) of the form definition file
• attribute-name: name of the request attribute in which to store the form instance

Version:

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

Field Summary

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

ROLE

Constructor Summary

MakeFormAction()

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.
void	service(ServiceManager serviceManager)

Methods inherited from class java.lang.Object

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

Constructor Detail

MakeFormAction

public MakeFormAction()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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.

Specified by:

act in interface Action

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