1 package org.kuali.ole.docstore.service;
2
3 import org.kuali.ole.docstore.OleDocStoreException;
4 import org.kuali.ole.docstore.model.xmlpojo.ingest.Request;
5 import org.kuali.ole.docstore.model.xmlpojo.ingest.Response;
6 import org.kuali.ole.docstore.process.batch.BulkProcessRequest;
7
8 /**
9 * Defines the services/operations that can be performed on one or more documents.
10 * This is the API for clients running in the same JVM as DocStore.
11 * User: tirumalesh.b
12 * Date: 28/8/12 Time: 11:54 AM
13 */
14 public interface DocumentService {
15
16 /**
17 * Processes the documents, as per the operation specified, in the given request.
18 * The given request specifies a single operation to be performed on one or more documents
19 * of same or different [cat-type-format].
20 *
21 * @param request
22 * @return
23 * @throws OleDocStoreException
24 */
25 public Response process(Request request) throws OleDocStoreException;
26
27 /**
28 * Processes the documents, as per the operation specified, in the given request.
29 * The given request specifies a single operation to be performed on generally a large number of documents
30 * of same [cat-type-format].
31 *
32 * @param request
33 * @return
34 * @throws OleDocStoreException
35 */
36 public void bulkProcess(BulkProcessRequest request) throws Exception;
37
38 /*
39 public Response ingest(Request request) throws OleDocStoreException;
40
41 public Response checkout(Request request) throws OleDocStoreException;
42
43 public Response checkin(Request request) throws OleDocStoreException;
44
45 public Response delete(Request request) throws OleDocStoreException;
46 */
47
48 }