org.bonitasoft.engine.api.impl

Class DocumentAPIImpl

java.lang.Object

org.bonitasoft.engine.api.impl.DocumentAPIImpl

All Implemented Interfaces:

DocumentAPI

public class DocumentAPIImpl
extends Object
implements DocumentAPI

Author:

Baptiste Mesta

Constructor Summary

Constructors

Constructor and Description
DocumentAPIImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Document	addDocument(long processInstanceId, String documentName, String description, DocumentValue documentValue)
Document	attachDocument(long processInstanceId, String documentName, String fileName, String mimeType, byte[] documentContent)
Document	attachDocument(long processInstanceId, String documentName, String fileName, String mimeType, String url)
Document	attachNewDocumentVersion(long processInstanceId, String documentName, String contentFileName, String contentMimeType, byte[] documentContent)
Document	attachNewDocumentVersion(long processInstanceId, String documentName, String fileName, String mimeType, String url)
void	deleteContentOfArchivedDocument(long documentId)
ArchivedDocument	getArchivedProcessDocument(long archivedProcessDocumentId)
ArchivedDocument	getArchivedVersionOfProcessDocument(long sourceObjectId)
Document	getDocument(long documentId)
Document	getDocumentAtActivityInstanceCompletion(long activityInstanceId, String documentName)
Document	getDocumentAtProcessInstantiation(long processInstanceId, String documentName)
byte[]	getDocumentContent(String documentStorageId)
List<Document>	getDocumentList(long processInstanceId, String name, int fromIndex, int numberOfResult)
Document	getLastDocument(long processInstanceId, String documentName)
List<Document>	getLastVersionOfDocuments(long processInstanceId, int pageIndex, int numberPerPage, DocumentCriterion pagingCriterion)
long	getNumberOfDocuments(long processInstanceId)
Document	removeDocument(long documentId)
SearchResult<ArchivedDocument>	searchArchivedDocuments(SearchOptions searchOptions)
SearchResult<ArchivedDocument>	searchArchivedDocumentsSupervisedBy(long userId, SearchOptions searchOptions)
SearchResult<Document>	searchDocuments(SearchOptions searchOptions)
SearchResult<Document>	searchDocumentsSupervisedBy(long userId, SearchOptions searchOptions)
void	setDocumentList(long processInstanceId, String name, List<DocumentValue> documentsValues)
Document	updateDocument(long documentId, DocumentValue documentValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentAPIImpl

public DocumentAPIImpl()

Method Detail

attachDocument

public Document attachDocument(long processInstanceId,
                      String documentName,
                      String fileName,
                      String mimeType,
                      String url)
                        throws DocumentAttachmentException

Specified by:

attachDocument in interface DocumentAPI

Throws:

DocumentAttachmentException

addDocument

public Document addDocument(long processInstanceId,
                   String documentName,
                   String description,
                   DocumentValue documentValue)
                     throws DocumentAttachmentException,
                            AlreadyExistsException

Specified by:

addDocument in interface DocumentAPI

Throws:

DocumentAttachmentException

AlreadyExistsException

updateDocument

public Document updateDocument(long documentId,
                      DocumentValue documentValue)
                        throws DocumentAttachmentException

Specified by:

updateDocument in interface DocumentAPI

Throws:

DocumentAttachmentException

attachDocument

public Document attachDocument(long processInstanceId,
                      String documentName,
                      String fileName,
                      String mimeType,
                      byte[] documentContent)
                        throws DocumentAttachmentException

Specified by:

attachDocument in interface DocumentAPI

Throws:

DocumentAttachmentException

attachNewDocumentVersion

public Document attachNewDocumentVersion(long processInstanceId,
                                String documentName,
                                String fileName,
                                String mimeType,
                                String url)
                                  throws DocumentAttachmentException

Specified by:

attachNewDocumentVersion in interface DocumentAPI

Throws:

DocumentAttachmentException

attachNewDocumentVersion

public Document attachNewDocumentVersion(long processInstanceId,
                                String documentName,
                                String contentFileName,
                                String contentMimeType,
                                byte[] documentContent)
                                  throws DocumentAttachmentException

Specified by:

attachNewDocumentVersion in interface DocumentAPI

Throws:

DocumentAttachmentException

getDocument

public Document getDocument(long documentId)
                     throws DocumentNotFoundException

Specified by:

getDocument in interface DocumentAPI

Throws:

DocumentNotFoundException

getLastVersionOfDocuments

public List<Document> getLastVersionOfDocuments(long processInstanceId,
                                       int pageIndex,
                                       int numberPerPage,
                                       DocumentCriterion pagingCriterion)
                                         throws DocumentException

Specified by:

getLastVersionOfDocuments in interface DocumentAPI

Throws:

DocumentException

getDocumentContent

public byte[] getDocumentContent(String documentStorageId)
                          throws DocumentNotFoundException

Specified by:

getDocumentContent in interface DocumentAPI

Throws:

DocumentNotFoundException

getLastDocument

public Document getLastDocument(long processInstanceId,
                       String documentName)
                         throws DocumentNotFoundException

Specified by:

getLastDocument in interface DocumentAPI

Throws:

DocumentNotFoundException

getNumberOfDocuments

public long getNumberOfDocuments(long processInstanceId)
                          throws DocumentException

Specified by:

getNumberOfDocuments in interface DocumentAPI

Throws:

DocumentException

getDocumentAtProcessInstantiation

public Document getDocumentAtProcessInstantiation(long processInstanceId,
                                         String documentName)
                                           throws DocumentNotFoundException

Specified by:

getDocumentAtProcessInstantiation in interface DocumentAPI

Throws:

DocumentNotFoundException

getDocumentAtActivityInstanceCompletion

public Document getDocumentAtActivityInstanceCompletion(long activityInstanceId,
                                               String documentName)
                                                 throws DocumentNotFoundException

Specified by:

getDocumentAtActivityInstanceCompletion in interface DocumentAPI

Throws:

DocumentNotFoundException

searchDocuments

public SearchResult<Document> searchDocuments(SearchOptions searchOptions)
                                       throws SearchException

Specified by:

searchDocuments in interface DocumentAPI

Throws:

SearchException

searchDocumentsSupervisedBy

public SearchResult<Document> searchDocumentsSupervisedBy(long userId,
                                                 SearchOptions searchOptions)
                                                   throws SearchException

Specified by:

searchDocumentsSupervisedBy in interface DocumentAPI

Throws:

SearchException

searchArchivedDocuments

public SearchResult<ArchivedDocument> searchArchivedDocuments(SearchOptions searchOptions)
                                                       throws SearchException

Specified by:

searchArchivedDocuments in interface DocumentAPI

Throws:

SearchException

searchArchivedDocumentsSupervisedBy

public SearchResult<ArchivedDocument> searchArchivedDocumentsSupervisedBy(long userId,
                                                                 SearchOptions searchOptions)
                                                                   throws SearchException

Specified by:

searchArchivedDocumentsSupervisedBy in interface DocumentAPI

Throws:

SearchException

getArchivedVersionOfProcessDocument

public ArchivedDocument getArchivedVersionOfProcessDocument(long sourceObjectId)
                                                     throws ArchivedDocumentNotFoundException

Specified by:

getArchivedVersionOfProcessDocument in interface DocumentAPI

Throws:

ArchivedDocumentNotFoundException

getArchivedProcessDocument

public ArchivedDocument getArchivedProcessDocument(long archivedProcessDocumentId)
                                            throws ArchivedDocumentNotFoundException

Specified by:

getArchivedProcessDocument in interface DocumentAPI

Throws:

ArchivedDocumentNotFoundException

removeDocument

public Document removeDocument(long documentId)
                        throws DocumentNotFoundException,
                               DeletionException

Specified by:

removeDocument in interface DocumentAPI

Throws:

DocumentNotFoundException

DeletionException

getDocumentList

public List<Document> getDocumentList(long processInstanceId,
                             String name,
                             int fromIndex,
                             int numberOfResult)
                               throws DocumentNotFoundException

Specified by:

getDocumentList in interface DocumentAPI

Throws:

DocumentNotFoundException

setDocumentList

public void setDocumentList(long processInstanceId,
                   String name,
                   List<DocumentValue> documentsValues)
                     throws DocumentException

Specified by:

setDocumentList in interface DocumentAPI

Throws:

DocumentException

deleteContentOfArchivedDocument

public void deleteContentOfArchivedDocument(long documentId)
                                     throws DocumentException,
                                            DocumentNotFoundException

Specified by:

deleteContentOfArchivedDocument in interface DocumentAPI

Throws:

DocumentException

DocumentNotFoundException