Java Doc for EndState.java in  » Workflow-Engines » spring-webflow-1.0.4 » org » springframework » webflow » engine » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Workflow Engines » spring webflow 1.0.4 » org.springframework.webflow.engine 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.springframework.webflow.engine.AnnotatedObject
      org.springframework.webflow.engine.State
         org.springframework.webflow.engine.EndState

EndState
public class EndState extends State (Code)
A state that ends a flow when entered. More specifically, this state ends the active flow session of the active flow execution associated with the current request context.

If the ended session is the "root flow session" the entire flow execution ends, signaling the end of a logical conversation.

If the terminated session was acting as a subflow the flow execution continues and control is returned to the parent flow session. In that case, this state returns an ending result event the resuming parent flow is expected to respond to.

An end state may optionally be configured with the name of a view to render when entered. This view will be rendered if the end state terminates the entire flow execution as a kind of flow ending "confirmation page".

Note: if no viewName property is specified and this end state terminates the entire flow execution it is expected that some action has already written the response (or else a blank response will result). On the other hand, if no viewName is specified and this end state relinquishes control back to a parent flow, view selection responsibility falls on the parent flow.
See Also:   org.springframework.webflow.engine.ViewSelector
See Also:   org.springframework.webflow.engine.SubflowState
author:
   Keith Donald
author:
   Colin Sampaleanu
author:
   Erwin Vervaet




Constructor Summary
public  EndState(Flow flow, String id)
     Create a new end state with no associated view.
Parameters:
  flow - the owning flow
Parameters:
  id - the state identifier (must be unique to the flow)
throws:
  IllegalArgumentException - when this state cannot be added to givenflow, e.g.

Method Summary
protected  voidappendToString(ToStringCreator creator)
    
protected  LocalAttributeMapcreateSessionOutput(RequestContext context)
     Returns the subflow output map.
protected  ViewSelectiondoEnter(RequestControlContext context)
     Specialization of State's doEnter template method that executes behaviour specific to this state type in polymorphic fashion.
public  AttributeMappergetOutputMapper()
     Returns the configured attribute mapper for mapping output attributes exposed by this end state when it is entered.
public  ViewSelectorgetViewSelector()
     Returns the strategy used to select the view to render in this end state if it terminates a root flow.
public  voidsetOutputMapper(AttributeMapper outputMapper)
     Sets the attribute mapper to use for mapping output attributes exposed by this end state when it is entered.
public  voidsetViewSelector(ViewSelector viewSelector)
     Sets the strategy used to select the view to render when this end state is entered and terminates a root flow.


Constructor Detail
EndState
public EndState(Flow flow, String id) throws IllegalArgumentException(Code)
Create a new end state with no associated view.
Parameters:
  flow - the owning flow
Parameters:
  id - the state identifier (must be unique to the flow)
throws:
  IllegalArgumentException - when this state cannot be added to givenflow, e.g. because the id is not unique
See Also:   State.State(FlowString)
See Also:   EndState.setViewSelector(ViewSelector)
See Also:   EndState.setOutputMapper(AttributeMapper)




Method Detail
appendToString
protected void appendToString(ToStringCreator creator)(Code)



createSessionOutput
protected LocalAttributeMap createSessionOutput(RequestContext context)(Code)
Returns the subflow output map. This will invoke the output mapper (if any) to map data available in the flow execution request context into a newly created empty map.



doEnter
protected ViewSelection doEnter(RequestControlContext context) throws FlowExecutionException(Code)
Specialization of State's doEnter template method that executes behaviour specific to this state type in polymorphic fashion.

This implementation pops the top (active) flow session off the execution stack, ending it, and resumes control in the parent flow (if neccessary). If the ended session is the root flow, a ViewSelection is returned.
Parameters:
  context - the control context for the currently executing flow, usedby this state to manipulate the flow execution a view selection signaling that control should be returned to theclient and a view rendered
throws:
  FlowExecutionException - if an exception occurs in this state




getOutputMapper
public AttributeMapper getOutputMapper()(Code)
Returns the configured attribute mapper for mapping output attributes exposed by this end state when it is entered.



getViewSelector
public ViewSelector getViewSelector()(Code)
Returns the strategy used to select the view to render in this end state if it terminates a root flow.



setOutputMapper
public void setOutputMapper(AttributeMapper outputMapper)(Code)
Sets the attribute mapper to use for mapping output attributes exposed by this end state when it is entered.



setViewSelector
public void setViewSelector(ViewSelector viewSelector)(Code)
Sets the strategy used to select the view to render when this end state is entered and terminates a root flow.



Fields inherited from org.springframework.webflow.engine.State
final protected Log logger(Code)(Java Doc)

Methods inherited from org.springframework.webflow.engine.State
protected void appendToString(ToStringCreator creator)(Code)(Java Doc)
abstract protected ViewSelection doEnter(RequestControlContext context) throws FlowExecutionException(Code)(Java Doc)
final public ViewSelection enter(RequestControlContext context) throws FlowExecutionException(Code)(Java Doc)
public boolean equals(Object o)(Code)(Java Doc)
public ActionList getEntryActionList()(Code)(Java Doc)
public FlowExecutionExceptionHandlerSet getExceptionHandlerSet()(Code)(Java Doc)
public Flow getFlow()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
public FlowDefinition getOwner()(Code)(Java Doc)
public ViewSelection handleException(FlowExecutionException exception, RequestControlContext context)(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isStartState()(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Fields inherited from org.springframework.webflow.engine.AnnotatedObject
final public static String CAPTION_PROPERTY(Code)(Java Doc)
final public static String DESCRIPTION_PROPERTY(Code)(Java Doc)

Methods inherited from org.springframework.webflow.engine.AnnotatedObject
public MutableAttributeMap getAttributeMap()(Code)(Java Doc)
public AttributeMap getAttributes()(Code)(Java Doc)
public String getCaption()(Code)(Java Doc)
public String getDescription()(Code)(Java Doc)
public void setCaption(String caption)(Code)(Java Doc)
public void setDescription(String description)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.