1 /**
2 * Copyright 2005-2012 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kns.service;
17
18 import org.kuali.rice.kew.api.WorkflowDocument;
19 import org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase;
20 import org.kuali.rice.krad.UserSession;
21
22 import java.sql.Timestamp;
23
24 /**
25 * @author Kuali Rice Team (rice.collab@kuali.org)
26 */
27 @Deprecated
28 public interface SessionDocumentService {
29
30 /**
31 * Retrieves a document from the user session for the given document id
32 */
33 public WorkflowDocument getDocumentFromSession(UserSession userSession, String docId);
34
35 /**
36 * This method places a document into the user session.
37 */
38 public void addDocumentToUserSession(UserSession userSession, WorkflowDocument document);
39
40 /**
41 * Delete KualiDocumentFormBase from session and database.
42 *
43 * @param documentNumber
44 * @param docFormKey
45 * @param userSession
46 * @throws
47 */
48 public void purgeDocumentForm(String documentNumber, String docFormKey, UserSession userSession, String ipAddress);
49
50 /**
51 * Delete KualiDocumentFormBases from database.
52 *
53 * @param documentNumber
54 * @throws
55 */
56 public void purgeAllSessionDocuments(Timestamp expirationDate);
57
58 /**
59 * Returns KualiDocumentFormBase object. It will check userSession first, if it failed then check database
60 *
61 * @param documentNumber
62 * @param docFormKey
63 * @param userSession
64 * @return KualiDocumentFormBase
65 * @throws
66 */
67 public KualiDocumentFormBase getDocumentForm(String documentNumber, String docFormKey, UserSession userSession,
68 String ipAddress);
69
70 /**
71 * Store KualiDocumentFormBase into session and database.
72 *
73 * @param KualiDocumentFormBase
74 * @param userSession
75 * @throws
76 */
77 public void setDocumentForm(KualiDocumentFormBase form, UserSession userSession, String ipAddress);
78 }