org.springframework.webflow.executor.jsf
Class FlowExecutionHolder

java.lang.Object
  org.springframework.webflow.executor.jsf.FlowExecutionHolder

All Implemented Interfaces:

java.io.Serializable

public class FlowExecutionHolder
extends java.lang.Object
implements java.io.Serializable

A holder storing a reference to a flow execution and the key of that flow execution if it has been (or is about to be) managed in a repository.

Author:

Keith Donald

See Also:

Serialized Form

Constructor Summary

FlowExecutionHolder(FlowExecution flowExecution)
Creates a new flow execution holder for a flow execution that has not yet been placed in a repository.

FlowExecutionHolder(FlowExecutionKey flowExecutionKey, FlowExecution flowExecution, FlowExecutionLock flowExecutionLock)
Creates a new flow execution holder for a flow execution that has been restored from a repository.

Method Summary

FlowExecution	getFlowExecution() Returns the flow execution.
FlowExecutionKey	getFlowExecutionKey() Returns the continuation key.
FlowExecutionLock	getFlowExecutionLock() Returns the flow execution lock
ViewSelection	getViewSelection() Returns the view selected from the current flow execution request.
void	replaceWith(FlowExecution flowExecution) Replace the current flow execution with the one provided.
void	setFlowExecutionKey(FlowExecutionKey key) Sets the continuation key.
void	setFlowExecutionLock(FlowExecutionLock lock) Sets the lock acquired on the flow execution
void	setViewSelection(ViewSelection viewSelection) Sets the selected view from the current flow execution request.
java.lang.String	toString()
void	unlockFlowExecutionIfNecessary() Unlock the held flow execution if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowExecutionHolder

public FlowExecutionHolder(FlowExecution flowExecution)

Creates a new flow execution holder for a flow execution that has not yet been placed in a repository.

Parameters:

flowExecution - the flow execution to hold

FlowExecutionHolder

public FlowExecutionHolder(FlowExecutionKey flowExecutionKey,
                           FlowExecution flowExecution,
                           FlowExecutionLock flowExecutionLock)

Creates a new flow execution holder for a flow execution that has been restored from a repository.

Parameters:

flowExecutionKey - the continuation key

flowExecution - the flow execution to hold

flowExecutionLock - the lock acquired on the flow execution

Method Detail

getFlowExecutionKey

public FlowExecutionKey getFlowExecutionKey()

Returns the continuation key.

setFlowExecutionKey

public void setFlowExecutionKey(FlowExecutionKey key)

Sets the continuation key.

getFlowExecution

public FlowExecution getFlowExecution()

Returns the flow execution.

getFlowExecutionLock

public FlowExecutionLock getFlowExecutionLock()

Returns the flow execution lock

setFlowExecutionLock

public void setFlowExecutionLock(FlowExecutionLock lock)

Sets the lock acquired on the flow execution

Parameters:

lock - the flow execution lock

getViewSelection

public ViewSelection getViewSelection()

Returns the view selected from the current flow execution request.

setViewSelection

public void setViewSelection(ViewSelection viewSelection)

Sets the selected view from the current flow execution request.

Parameters:

viewSelection - the view selection

replaceWith

public void replaceWith(FlowExecution flowExecution)

Replace the current flow execution with the one provided. This method will clear out all state associated with the original execution and unlock it if necessary.

Parameters:

flowExecution - the new "current" flow execution

unlockFlowExecutionIfNecessary

public void unlockFlowExecutionIfNecessary()

Unlock the held flow execution if necessary.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object