org.kuali.rice.kns.service
Interface SessionDocumentService

All Known Implementing Classes:

NoOpSessionDocumentServiceImpl, SessionDocumentServiceImpl

Deprecated.

@Deprecated
public interface SessionDocumentService

Author:

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

Method Summary

void	addDocumentToUserSession(UserSession userSession, WorkflowDocument document) Deprecated. This method places a document into the user session.
KualiDocumentFormBase	getDocumentForm(String documentNumber, String docFormKey, UserSession userSession, String ipAddress) Deprecated. Returns KualiDocumentFormBase object.
WorkflowDocument	getDocumentFromSession(UserSession userSession, String docId) Deprecated. Retrieves a document from the user session for the given document id
void	purgeAllSessionDocuments(Timestamp expirationDate) Deprecated. Delete KualiDocumentFormBases from database.
void	purgeDocumentForm(String documentNumber, String docFormKey, UserSession userSession, String ipAddress) Deprecated. Delete KualiDocumentFormBase from session and database.
void	setDocumentForm(KualiDocumentFormBase form, UserSession userSession, String ipAddress) Deprecated. Store KualiDocumentFormBase into session and database.

Method Detail

getDocumentFromSession

WorkflowDocument getDocumentFromSession(UserSession userSession,
                                        String docId)

Deprecated.

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

addDocumentToUserSession

void addDocumentToUserSession(UserSession userSession,
                              WorkflowDocument document)

Deprecated.

This method places a document into the user session.

purgeDocumentForm

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

Deprecated.

Delete KualiDocumentFormBase from session and database.

Parameters:

documentNumber -

docFormKey -

userSession -

Throws:

purgeAllSessionDocuments

void purgeAllSessionDocuments(Timestamp expirationDate)

Deprecated.

Delete KualiDocumentFormBases from database.

Parameters:

documentNumber -

Throws:

getDocumentForm

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

Deprecated.

Returns KualiDocumentFormBase object. It will check userSession first, if it failed then check database

Parameters:

documentNumber -

docFormKey -

userSession -

Returns:

KualiDocumentFormBase

Throws:

setDocumentForm

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

Deprecated.

Store KualiDocumentFormBase into session and database.

Parameters:

KualiDocumentFormBase -

userSession -

Throws: