com.livinglogic.struts.workflow
Class WorkflowContainer

java.lang.Object
  extended bycom.livinglogic.struts.workflow.WorkflowContainer
All Implemented Interfaces:
Serializable

public class WorkflowContainer
extends Object
implements Serializable

Class that provides access by label to Workflow objects stored in a user's session. An instance of this class is maintained in every user session.

Since:
$Name: $
Version:
$Revision: 1.3 $, $Date: 2004/04/08 14:58:23 $
Author:
A. Lamm, M. Bauer, D. White, $Author: jason_pratt $
See Also:
Serialized Form

Field Summary
static String WORKFLOW_CONTAINER_KEY
          The attribute key under which the WorkflowContainer object is stored in a user's session.
 
Constructor Summary
WorkflowContainer()
           
 
Method Summary
static WorkflowContainer get(javax.servlet.http.HttpSession session)
          Retrieves the WorkflowContainer object for a specified user session.
 Workflow getPrimary()
          Retrieves the primary Workflow object, if any is known at this time.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WORKFLOW_CONTAINER_KEY

public static final String WORKFLOW_CONTAINER_KEY
The attribute key under which the WorkflowContainer object is stored in a user's session.

See Also:
Constant Field Values
Constructor Detail

WorkflowContainer

public WorkflowContainer()
Method Detail

getPrimary

public Workflow getPrimary()
Retrieves the primary Workflow object, if any is known at this time.

Returns:
the primary Workflow object or null, if no primary workflow exists.

get

public static WorkflowContainer get(javax.servlet.http.HttpSession session)
Retrieves the WorkflowContainer object for a specified user session. If it doesn't exist yet, a new one is created and stored in the session.

Parameters:
session - the user's session object
Returns:
a WorkflowContainer object, possibly newly created


Copyright © 2004 Struts Workflow Extension Team. All Rights Reserved.