com.ervacon.springframework.web.servlet.mvc.webflow
Interface WebFlow

All Known Implementing Classes:

SimpleWebFlow

public interface WebFlow

Interface implemented by all web flow implementations. A web flow will normally be defined in an XML document conforming to the web flow DTD. For more details on how to define and use web flows, consult the package documentation and the web flow DTD.

A basic implementation is provided by the SimpleWebFlow.

Author:

Erwin Vervaet

See Also:

SimpleWebFlow

Method Summary

org.springframework.web.servlet.ModelAndView	execute(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String state, java.lang.String event, WebFlowMementoStack mementos) Execute an event in a state of the web flow.
org.springframework.web.servlet.ModelAndView	start(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, WebFlowMementoStack mementos) Start the web flow.

Method Detail

start

public org.springframework.web.servlet.ModelAndView start(javax.servlet.http.HttpServletRequest request,
                                                          javax.servlet.http.HttpServletResponse response,
                                                          WebFlowMementoStack mementos)
                                                   throws WebFlowException

Start the web flow.

Parameters:

request - current HTTP request

response - current HTTP response

mementos - flow call stack

Throws:

WebFlowException - in case of error

execute

public org.springframework.web.servlet.ModelAndView execute(javax.servlet.http.HttpServletRequest request,
                                                            javax.servlet.http.HttpServletResponse response,
                                                            java.lang.String state,
                                                            java.lang.String event,
                                                            WebFlowMementoStack mementos)
                                                     throws WebFlowException

Execute an event in a state of the web flow.

Parameters:

request - current HTTP request

response - current HTTP response

state - state in which the event should be triggered

event - event that should be signaled

mementos - flow call stack

Throws:

WebFlowException - in case of error