org.kuali.ole.docstore.document
Interface DocumentManager

All Known Implementing Classes:

AbstractDocumentManager, WorkBibDocumentManager, WorkBibMarcDocumentManager, WorkInstanceDocumentManager, WorkLicenseDocumentManager

public interface DocumentManager

Defines the operations that can be performed on one or more documents.

Version:

%I%, %G% Date: 28/8/12 Time: 12:17 PM

Author:

tirumalesh.b

Method Summary

void	bulkIngest(BulkProcessRequest bulkProcessRequest, List<RequestDocument> requestDocuments) Performs bulk ingest as per the details in the given bulkProcessRequest.
List<ResponseDocument>	checkin(List<RequestDocument> requestDocuments)
ResponseDocument	checkin(RequestDocument requestDocument, javax.jcr.Session session)
List<ResponseDocument>	checkout(List<RequestDocument> requestDocuments)
ResponseDocument	checkout(RequestDocument requestDocument, javax.jcr.Session session)
List<ResponseDocument>	delete(List<RequestDocument> requestDocuments)
ResponseDocument	delete(RequestDocument requestDocument, javax.jcr.Session session)
void	index(List<RequestDocument> requestDocuments, boolean commit) Indexes the given documents in discovery.
List<ResponseDocument>	ingest(List<RequestDocument> requestDocuments, javax.jcr.Session session) Ingests (stores and indexes) the given documents.
ResponseDocument	ingest(RequestDocument requestDocument, javax.jcr.Session session) Ingests (stores and indexes) the given document.

Method Detail

ingest

List<ResponseDocument> ingest(List<RequestDocument> requestDocuments,
                              javax.jcr.Session session)
                              throws OleDocStoreException

Ingests (stores and indexes) the given documents. Either all documents are saved or none.

Parameters:

requestDocuments -

Returns:

list of ResponseDocuments, if all RequestDocuments are ingested successfully.

Throws:

OleDocStoreException

ingest

ResponseDocument ingest(RequestDocument requestDocument,
                        javax.jcr.Session session)
                        throws OleDocStoreException

Ingests (stores and indexes) the given document.

Parameters:

requestDocument -

Returns:

Throws:

OleDocStoreException

checkout

List<ResponseDocument> checkout(List<RequestDocument> requestDocuments)
                                throws OleDocStoreException

Throws:

OleDocStoreException

checkout

ResponseDocument checkout(RequestDocument requestDocument,
                          javax.jcr.Session session)
                          throws OleDocStoreException

Throws:

OleDocStoreException

checkin

List<ResponseDocument> checkin(List<RequestDocument> requestDocuments)
                               throws OleDocStoreException

Throws:

OleDocStoreException

checkin

ResponseDocument checkin(RequestDocument requestDocument,
                         javax.jcr.Session session)
                         throws OleDocStoreException

Throws:

OleDocStoreException

delete

List<ResponseDocument> delete(List<RequestDocument> requestDocuments)
                              throws OleDocStoreException

Throws:

OleDocStoreException

delete

ResponseDocument delete(RequestDocument requestDocument,
                        javax.jcr.Session session)
                        throws OleDocStoreException

Throws:

OleDocStoreException

bulkIngest

void bulkIngest(BulkProcessRequest bulkProcessRequest,
                List<RequestDocument> requestDocuments)
                throws OleDocStoreException

Performs bulk ingest as per the details in the given bulkProcessRequest.

Parameters:

bulkProcessRequest -

requestDocuments - documents to be processed in the current invocation.

Throws:

OleDocStoreException

index

void index(List<RequestDocument> requestDocuments,
           boolean commit)
           throws OleDocStoreException

Indexes the given documents in discovery.

Parameters:

requestDocuments -

commit - indicates whether to commit the changes.

Throws:

OleDocStoreException