nl.gx.webmanager.handler.forms
Interface Router

All Superinterfaces:

FormComponent

All Known Implementing Classes:

GoBackRouter, GoToRouter, IfThenRouter, OgoneRouter, RequestRouter, VerificationCookieWriteRedirectRouter

public interface Router
extends FormComponent

This interface defines the api for routing components in the form handler. The formhandler will call the doRouting method on the routing instance, after it has been initialized. After that, the routing will be checked. If the result is not null and it's target link is also not null, then the form processing will be stopped and the client will be redirected to that target. If the end of flow flag has been set, then the flow values in the session of the client will be removed. If the result does not contain a valid target link, then the result will be ignored and processing the form will continue.

Method Summary

RoutingResult

doRouting(FormDefinition form, State formState, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Performs routing based on the form definition and the values of the client.

Methods inherited from interface nl.gx.webmanager.handler.forms.FormComponent

init

Method Detail

doRouting

RoutingResult doRouting(FormDefinition form,
                        State formState,
                        javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse res)

Performs routing based on the form definition and the values of the client.

Parameters:

form - The definition of the current form flow

formState - The object representing the state of the client filling out a form.

req - The http servlet request

res - The http servlet response

Returns:

The routing result for the form, or null if the router doesn't match