org.kuali.rice.kns.service.impl

Class NoOpSessionDocumentServiceImpl

java.lang.Object

org.kuali.rice.kns.service.impl.NoOpSessionDocumentServiceImpl

All Implemented Interfaces:

SessionDocumentService

public class NoOpSessionDocumentServiceImpl
extends Object
implements SessionDocumentService

A SessionDocumentService implementation which does nothing.

Author:

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

Constructor Summary

Constructors

Constructor and Description
NoOpSessionDocumentServiceImpl()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NoOpSessionDocumentServiceImpl

public NoOpSessionDocumentServiceImpl()

Method Detail

getDocumentFromSession

public WorkflowDocument getDocumentFromSession(UserSession userSession,
                                      String docId)

Description copied from interface: SessionDocumentService

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

Specified by:

getDocumentFromSession in interface SessionDocumentService

addDocumentToUserSession

public void addDocumentToUserSession(UserSession userSession,
                            WorkflowDocument document)

Description copied from interface: SessionDocumentService

This method places a document into the user session.

Specified by:

addDocumentToUserSession in interface SessionDocumentService

purgeDocumentForm

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

Description copied from interface: SessionDocumentService

Delete KualiDocumentFormBase from session and database.

Specified by:

purgeDocumentForm in interface SessionDocumentService

purgeAllSessionDocuments

public void purgeAllSessionDocuments(Timestamp expirationDate)

Description copied from interface: SessionDocumentService

Delete KualiDocumentFormBases from database.

Specified by:

purgeAllSessionDocuments in interface SessionDocumentService

getDocumentForm

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

Description copied from interface: SessionDocumentService

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

Specified by:

getDocumentForm in interface SessionDocumentService

Returns:

KualiDocumentFormBase

setDocumentForm

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

Description copied from interface: SessionDocumentService

Store KualiDocumentFormBase into session and database.

Specified by:

setDocumentForm in interface SessionDocumentService