Package org.kuali.rice.krad

Class UserSessionUtils

java.lang.Object

org.kuali.rice.krad.UserSessionUtils

public final class UserSessionUtils
extends Object

Utility class for working with the UserSession.

Method Summary

Modifier and Type	Method	Description
static void	addWorkflowDocument(UserSession userSession, org.kuali.rice.kew.api.WorkflowDocument workflowDocument)	Adds the given WorkflowDocument to the UserSession.
static org.kuali.rice.kew.api.WorkflowDocument	getWorkflowDocument(UserSession userSession, String workflowDocumentId)	Returns the WorkflowDocument with the given ID from the UserSession.

Methods inherited from class java.lang.Object

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

Method Details

addWorkflowDocument

public static void addWorkflowDocument(UserSession userSession,
 org.kuali.rice.kew.api.WorkflowDocument workflowDocument)

Adds the given WorkflowDocument to the UserSession.

Parameters:

userSession - the session to add the workflow document to

workflowDocument - the workflow doc to add to the session

getWorkflowDocument

public static org.kuali.rice.kew.api.WorkflowDocument getWorkflowDocument(UserSession userSession,
 String workflowDocumentId)

Returns the WorkflowDocument with the given ID from the UserSession. If there is not one cached in the session with that ID, then null is returned.

Parameters:

userSession - the user session from which to retrieve the workflow document

workflowDocumentId - the ID of the workflow document to get

Returns:

the cached workflow document, or null if a document with that ID is not cached in the user session