Package org.kuali.rice.kns.service

Interface SessionDocumentService

@Deprecated public interface SessionDocumentService
Deprecated.
Only used by KNS classes, no KRAD equivalent available.
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.
    KualiDocumentFormBase
    getDocumentForm(String documentNumber, String docFormKey, org.kuali.rice.krad.UserSession userSession, String ipAddress)
    Deprecated.
    Returns KualiDocumentFormBase object.
    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 KualiDocumentFormBases from database.
    void
    purgeDocumentForm(String documentNumber, String docFormKey, org.kuali.rice.krad.UserSession userSession, String ipAddress)
    Deprecated.
    Delete KualiDocumentFormBase from session and database.
    void
    setDocumentForm(KualiDocumentFormBase form, org.kuali.rice.krad.UserSession userSession, String ipAddress)
    Deprecated.
    Store KualiDocumentFormBase 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 KualiDocumentFormBase from session and database.
      Parameters:
      documentNumber -
      docFormKey -
      userSession -

    • purgeAllSessionDocuments

      void purgeAllSessionDocuments(Timestamp expirationDate)
      Deprecated.
      Delete KualiDocumentFormBases from database.
      Parameters:
      documentNumber -

    • getDocumentForm

      KualiDocumentFormBase getDocumentForm(String documentNumber, String docFormKey, org.kuali.rice.krad.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

    • setDocumentForm

      void setDocumentForm(KualiDocumentFormBase form, org.kuali.rice.krad.UserSession userSession, String ipAddress)
      Deprecated.
      Store KualiDocumentFormBase into session and database.
      Parameters:
      userSession -
      KualiDocumentFormBase -