org.kuali.rice.krad.service

Interface SessionDocumentService

All Known Implementing Classes:

SessionDocumentServiceImpl

public interface SessionDocumentService

Service API for persisting Document form content and retrieving back

Used as an extension to session support. If a session times out, the doucment contents can be retrieved from the persistence storage and work resumed

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocumentToUserSession(UserSession userSession, WorkflowDocument document) This method places a document into the user session.
DocumentFormBase	getDocumentForm(String documentNumber, String docFormKey, UserSession userSession, String ipAddress) Returns DocumentFormBase object from the db
WorkflowDocument	getDocumentFromSession(UserSession userSession, String docId) Retrieves a document from the user session for the given document id
void	purgeAllSessionDocuments(Timestamp expirationDate) Delete KualiDocumentFormBase from session and database.
void	purgeDocumentForm(String documentNumber, String docFormKey, UserSession userSession, String ipAddress) Delete DocumentFormBase from session and database.
void	setDocumentForm(DocumentFormBase form, UserSession userSession, String ipAddress) This method stores a UifFormBase into session and database

Method Detail

getDocumentFromSession

WorkflowDocument getDocumentFromSession(UserSession userSession,
                                      String docId)

Retrieves a document from the user session for the given document id

addDocumentToUserSession

void addDocumentToUserSession(UserSession userSession,
                            WorkflowDocument document)

This method places a document into the user session.

purgeDocumentForm

void purgeDocumentForm(String documentNumber,
                     String docFormKey,
                     UserSession userSession,
                     String ipAddress)

Delete DocumentFormBase from session and database.

Parameters:

documentNumber -

docFormKey -

userSession -

Throws:

purgeAllSessionDocuments

void purgeAllSessionDocuments(Timestamp expirationDate)

Delete KualiDocumentFormBase from session and database.

Parameters:

documentNumber -

Throws:

setDocumentForm

void setDocumentForm(DocumentFormBase form,
                   UserSession userSession,
                   String ipAddress)

This method stores a UifFormBase into session and database

Parameters:

form -

userSession -

ipAddress -

getDocumentForm

DocumentFormBase getDocumentForm(String documentNumber,
                               String docFormKey,
                               UserSession userSession,
                               String ipAddress)

Returns DocumentFormBase object from the db

Parameters:

documentNumber -

docFormKey -

userSession -

ipAddress -

Returns: