org.kuali.rice.krad.service.impl
Class SessionDocumentServiceImpl

java.lang.Object
  org.kuali.rice.krad.service.impl.SessionDocumentServiceImpl

All Implemented Interfaces:

SessionDocumentService

@Transactional
public class SessionDocumentServiceImpl
extends Object
implements SessionDocumentService

Implementation of SessionDocumentService that persists the document form contents to the underlying database

Author:

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

Field Summary

protected static String	DOCUMENT_NUMBER
protected static String	IP_ADDRESS
protected static String	PRINCIPAL_ID
protected static String	SESSION_ID

Constructor Summary

SessionDocumentServiceImpl()

Method Summary

void	addDocumentToUserSession(UserSession userSession, WorkflowDocument document) This method places a document into the user session.
protected BusinessObjectService	getBusinessObjectService()
protected DataDictionaryService	getDataDictionaryService()
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
protected EncryptionService	getEncryptionService()
protected SessionDocumentDao	getSessionDocumentDao()
protected void	persistDocumentForm(DocumentFormBase form, UserSession userSession, String ipAddress, String sessionId, String documentNumber)
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.
protected Object	retrieveDocumentForm(UserSession userSession, String sessionId, String documentNumber, String ipAddress)
void	setBusinessObjectService(BusinessObjectService businessObjectService)
void	setDocumentForm(DocumentFormBase form, UserSession userSession, String ipAddress) This method stores a UifFormBase into session and database
void	setSessionDocumentDao(SessionDocumentDao sessionDocumentDao)

Methods inherited from class java.lang.Object

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

Field Detail

IP_ADDRESS

protected static final String IP_ADDRESS

See Also:

Constant Field Values

PRINCIPAL_ID

protected static final String PRINCIPAL_ID

See Also:

Constant Field Values

DOCUMENT_NUMBER

protected static final String DOCUMENT_NUMBER

See Also:

Constant Field Values

SESSION_ID

protected static final String SESSION_ID

See Also:

Constant Field Values

Constructor Detail

SessionDocumentServiceImpl

public SessionDocumentServiceImpl()

Method Detail

getDocumentForm

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

Description copied from interface: SessionDocumentService

Returns DocumentFormBase object from the db

Specified by:

getDocumentForm in interface SessionDocumentService

Returns:

retrieveDocumentForm

protected Object retrieveDocumentForm(UserSession userSession,
                                      String sessionId,
                                      String documentNumber,
                                      String ipAddress)
                               throws Exception

Throws:

Exception

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

See Also:

org.kuali.rice.krad.service.SessionDocumentService#addDocumentToUserSession(org.kuali.rice.krad.UserSession, org.kuali.rice.krad.workflow.service.KualiWorkflowDocument)

purgeDocumentForm

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

Description copied from interface: SessionDocumentService

Delete DocumentFormBase from session and database.

Specified by:

purgeDocumentForm in interface SessionDocumentService

See Also:

org.kuali.rice.krad.service.SessionDocumentService#purgeDocumentForm(String documentNumber, String docFormKey, UserSession userSession)

setDocumentForm

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

Description copied from interface: SessionDocumentService

This method stores a UifFormBase into session and database

Specified by:

setDocumentForm in interface SessionDocumentService

persistDocumentForm

protected void persistDocumentForm(DocumentFormBase form,
                                   UserSession userSession,
                                   String ipAddress,
                                   String sessionId,
                                   String documentNumber)

purgeAllSessionDocuments

public void purgeAllSessionDocuments(Timestamp expirationDate)

Description copied from interface: SessionDocumentService

Delete KualiDocumentFormBase from session and database.

Specified by:

purgeAllSessionDocuments in interface SessionDocumentService

See Also:

SessionDocumentService.purgeAllSessionDocuments(java.sql.Timestamp)

getSessionDocumentDao

protected SessionDocumentDao getSessionDocumentDao()

setSessionDocumentDao

public void setSessionDocumentDao(SessionDocumentDao sessionDocumentDao)

getBusinessObjectService

protected BusinessObjectService getBusinessObjectService()

setBusinessObjectService

public void setBusinessObjectService(BusinessObjectService businessObjectService)

getEncryptionService

protected EncryptionService getEncryptionService()

getDataDictionaryService

protected DataDictionaryService getDataDictionaryService()