Package org.kuali.rice.krad.service

Interface SessionDocumentService

All Known Implementing Classes:
SessionDocumentServiceImpl
@Deprecated public interface SessionDocumentService
Deprecated.
(Deprecated and removed from use in KRAD (KULRICE-9149)

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

Service API for persisting Document form content and retrieving back
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

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

  • Method Details

    • getDocumentFromSession

      org.kuali.rice.kew.api.WorkflowDocument getDocumentFromSession(org.kuali.rice.krad.UserSession userSession, String docId)
      Deprecated.
      Retrieves a document from the user session for the given document id

    • addDocumentToUserSession

      void addDocumentToUserSession(org.kuali.rice.krad.UserSession userSession, org.kuali.rice.kew.api.WorkflowDocument document)
      Deprecated.
      This method places a document into the user session.

    • purgeDocumentForm

      void purgeDocumentForm(String documentNumber, String docFormKey, org.kuali.rice.krad.UserSession userSession, String ipAddress)
      Deprecated.
      Delete DocumentFormBase from session and database.
      Parameters:
      documentNumber -
      docFormKey -
      userSession -

    • purgeAllSessionDocuments

      void purgeAllSessionDocuments(Timestamp expirationDate)
      Deprecated.
      Delete KualiDocumentFormBase from session and database.
      Parameters:
      documentNumber -

    • setDocumentForm

      void setDocumentForm(org.kuali.rice.krad.web.form.DocumentFormBase form, org.kuali.rice.krad.UserSession userSession, String ipAddress)
      Deprecated.
      This method stores a UifFormBase into session and database
      Parameters:
      form -
      userSession -
      ipAddress -

    • getDocumentForm

      org.kuali.rice.krad.web.form.DocumentFormBase getDocumentForm(String documentNumber, String docFormKey, org.kuali.rice.krad.UserSession userSession, String ipAddress)
      Deprecated.
      Returns DocumentFormBase object from the db
      Parameters:
      documentNumber -
      docFormKey -
      userSession -
      ipAddress -
      Returns: