org.kuali.ole.docstore.document

Interface DocumentManager

All Known Implementing Classes:

AbstractDocumentManager, JcrAbstractDocumentManager, JcrJcrWorkHoldingsDocumentManager, JcrWorkBibDocumentManager, JcrWorkBibMarcDocumentManager, JcrWorkInstanceDocumentManager, JcrWorkItemDocumentManager, JcrWorkLicenseDocumentManager, RdbmsAbstarctDocumentManager, RdbmsWorkBibDocumentManager, RdbmsWorkBibMarcDocumentManager, RdbmsWorkEHoldingsDocumentManager, RdbmsWorkEInstanceDocumentManager, RdbmsWorkHoldingsDocumentManager, RdbmsWorkInstanceDocumentManager, RdbmsWorkItemDocumentManager

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

Methods

Modifier and Type	Method and Description
void	addResourceId(RequestDocument requestDocument, ResponseDocument respDoc)
ResponseDocument	bind(RequestDocument requestDocument, Object object, String operation)
ResponseDocument	buildResponseDocument(RequestDocument requestDocument)
void	bulkIngest(BulkProcessRequest bulkProcessRequest, List<RequestDocument> requestDocuments) Performs bulk ingest as per the details in the given bulkProcessRequest.
List<ResponseDocument>	checkin(List<RequestDocument> requestDocuments, Object object)
ResponseDocument	checkin(RequestDocument requestDocument, Object object, ResponseDocument respDoc)
List<ResponseDocument>	checkout(List<RequestDocument> requestDocuments, Object object)
ResponseDocument	checkout(RequestDocument requestDocument, Object object)
List<ResponseDocument>	delete(List<RequestDocument> requestDocuments, Object object)
ResponseDocument	delete(RequestDocument requestDocument, Object object)
List<ResponseDocument>	deleteVerify(List<RequestDocument> requestDocument, Object object)
ResponseDocument	deleteVerify(RequestDocument requestDocument, Object object)
void	index(List<RequestDocument> requestDocuments, boolean commit) Indexes the given documents in discovery.
List<ResponseDocument>	ingest(List<RequestDocument> requestDocuments, Object object) Ingests (stores and indexes) the given documents.
ResponseDocument	ingest(RequestDocument requestDocument, Object object, ResponseDocument respDoc) Ingests (stores and indexes) the given document.
javax.jcr.Node	storeDocument(RequestDocument requestDocument, Object object, ResponseDocument responseDocument) Deletes the given documents, along with linked documents, from the discovery.
ResponseDocument	unbind(RequestDocument requestDocument, Object object, String operation)
void	validateInput(RequestDocument requestDocument, Object object, List<String> valuesList)

Method Detail

ingest

List<ResponseDocument> ingest(List<RequestDocument> requestDocuments,
                            Object object)
                              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,
                      Object object,
                      ResponseDocument respDoc)
                        throws OleDocStoreException

Ingests (stores and indexes) the given document.

Parameters:

requestDocument -

respDoc -

Returns:

Throws:

OleDocStoreException

checkout

List<ResponseDocument> checkout(List<RequestDocument> requestDocuments,
                              Object object)
                                throws OleDocStoreException

Throws:

OleDocStoreException

checkout

ResponseDocument checkout(RequestDocument requestDocument,
                        Object object)
                          throws OleDocStoreException

Throws:

OleDocStoreException

checkin

List<ResponseDocument> checkin(List<RequestDocument> requestDocuments,
                             Object object)
                               throws OleDocStoreException

Throws:

OleDocStoreException

checkin

ResponseDocument checkin(RequestDocument requestDocument,
                       Object object,
                       ResponseDocument respDoc)
                         throws OleDocStoreException

Throws:

OleDocStoreException

delete

List<ResponseDocument> delete(List<RequestDocument> requestDocuments,
                            Object object)
                              throws Exception

Throws:

Exception

delete

ResponseDocument delete(RequestDocument requestDocument,
                      Object object)
                        throws Exception

Throws:

Exception

buildResponseDocument

ResponseDocument buildResponseDocument(RequestDocument requestDocument)

validateInput

void validateInput(RequestDocument requestDocument,
                 Object object,
                 List<String> valuesList)
                   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

storeDocument

javax.jcr.Node storeDocument(RequestDocument requestDocument,
                           Object object,
                           ResponseDocument responseDocument)
                             throws OleDocStoreException

Deletes the given documents, along with linked documents, from the discovery.

Parameters:

requestDocument -

responseDocument -

Throws:

OleDocStoreException

bind

ResponseDocument bind(RequestDocument requestDocument,
                    Object object,
                    String operation)
                      throws OleDocStoreException,
                             javax.jcr.RepositoryException,
                             OleException,
                             FileNotFoundException

Throws:

OleDocStoreException

javax.jcr.RepositoryException

OleException

FileNotFoundException

unbind

ResponseDocument unbind(RequestDocument requestDocument,
                      Object object,
                      String operation)
                        throws OleDocStoreException,
                               javax.jcr.RepositoryException,
                               OleException,
                               FileNotFoundException

Throws:

OleDocStoreException

javax.jcr.RepositoryException

OleException

FileNotFoundException

deleteVerify

List<ResponseDocument> deleteVerify(List<RequestDocument> requestDocument,
                                  Object object)

deleteVerify

ResponseDocument deleteVerify(RequestDocument requestDocument,
                            Object object)
                              throws Exception

Throws:

Exception

addResourceId

void addResourceId(RequestDocument requestDocument,
                 ResponseDocument respDoc)