org.wizard4j.engine
Class FlowchartEngine

java.lang.Object
  extended by org.wizard4j.engine.SessionManager
      extended by org.wizard4j.engine.FlowchartEngine

public class FlowchartEngine
extends SessionManager

The FlowchartEngine can be requested to create either managed or unmanaged FlowchartSessions.

An application using wizard4j will typically contain code similar to the following excerpt.

 WizardValidator validator = WizardFactory.newWizardValidator();
 Flowchart flowchart = validator.validateFlowchart(flowchartSource);
 FlowchartEngine flowchartEngine = WizardFactory.newFlowchartEngine();
 String flowchartSessionId = flowchartEngine.createManagedSession(flowchart);
 FlowchartResponse flowchartResponse = flowchartEngine.start(flowchartSessionId);
 ...
 


Constructor Summary
FlowchartEngine(int sessionTimeout)
           
 
Method Summary
 java.lang.String createManagedSession(Flowchart flowchart)
          Create a managed session.
 FlowchartSession createSession(Flowchart flowchart)
          Create an unmanaged session, the user is responsible for the lifecycle of the session.
 
Methods inherited from class org.wizard4j.engine.SessionManager
cancel, getDefaultGroupType, getResult, getSessionTimeout, index, isDefaultAllowMultipleRatesPerRun, isDefaultAllowMultipleSavesPerRun, isDefaultAutomaticSave, isDefaultKeepStateInResponse, isDefaultMaskCancelAction, isDefaultMaskIndexAction, isDefaultMaskNextAction, isDefaultMaskPreviousAction, isDefaultMaskRateAction, isDefaultMaskSaveAction, isDefaultMaskStartAction, isDefaultMaskStateAction, isDefaultResendResponseAtRequestError, isDefaultResendResponseWithErrorAtParameterError, next, previous, rate, save, setActionMask, setAllowMultipleRatesPerRun, setAllowMultipleSavesPerRun, setAutomaticSave, setDefaultAllowMultipleRatesPerRun, setDefaultAllowMultipleSavesPerRun, setDefaultAutomaticSave, setDefaultGroupType, setDefaultKeepStateInResponse, setDefaultMaskCancelAction, setDefaultMaskIndexAction, setDefaultMaskNextAction, setDefaultMaskPreviousAction, setDefaultMaskRateAction, setDefaultMaskSaveAction, setDefaultMaskStartAction, setDefaultMaskStateAction, setDefaultResendResponseAtRequestError, setDefaultResendResponseWithErrorAtParameterError, setFlowchartMonitor, setGroupType, setResendResponseAtRequestError, setResendResponseWithErrorAtParameterError, setStoreStateInResponse, start, state
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FlowchartEngine

public FlowchartEngine(int sessionTimeout)
Parameters:
sessionTimeout -
Method Detail

createSession

public FlowchartSession createSession(Flowchart flowchart)
Create an unmanaged session, the user is responsible for the lifecycle of the session.

Parameters:
flowchart -
Returns:
flowchartSession

createManagedSession

public java.lang.String createManagedSession(Flowchart flowchart)
Create a managed session.

Parameters:
flowchart -
Returns:
sessionId