org.bonitasoft.engine.core.document.api.impl

Class DocumentServiceImpl

java.lang.Object

org.bonitasoft.engine.core.document.api.impl.DocumentServiceImpl

All Implemented Interfaces:

org.bonitasoft.engine.core.document.api.DocumentService

public class DocumentServiceImpl
extends Object
implements org.bonitasoft.engine.core.document.api.DocumentService

Author:

Nicolas Chabanoles, Matthieu Chaffotte, Celine Souchet, Baptiste Mesta

Field Summary

Fields inherited from interface org.bonitasoft.engine.core.document.api.DocumentService

DOCUMENT, DOCUMENTMAPPING, SUPERVISED_BY

Constructor Summary

Constructors

Constructor and Description
DocumentServiceImpl(org.bonitasoft.engine.recorder.Recorder recorder, org.bonitasoft.engine.persistence.ReadPersistenceService persistenceService, SDocumentDownloadURLProvider urlProvider, org.bonitasoft.engine.events.EventService eventService, org.bonitasoft.engine.archive.ArchiveService archiveService)

Method Summary

Methods

Modifier and Type	Method and Description
void	archive(org.bonitasoft.engine.core.document.model.SDocumentMapping docMapping, long archiveDate)
org.bonitasoft.engine.core.document.model.SMappedDocument	attachDocumentToProcessInstance(org.bonitasoft.engine.core.document.model.SDocument document, long processInstanceId, String name, String description)
org.bonitasoft.engine.core.document.model.SMappedDocument	attachDocumentToProcessInstance(org.bonitasoft.engine.core.document.model.SDocument document, long processInstanceId, String name, String description, int index)
void	deleteArchivedDocuments(long instanceId)
void	deleteContentOfArchivedDocument(long documentId)
void	deleteDocument(org.bonitasoft.engine.core.document.model.SLightDocument document)
void	deleteDocumentsFromProcessInstance(Long processInstanceId)
String	generateDocumentURL(String name, String contentStorageId)
org.bonitasoft.engine.core.document.model.archive.SAMappedDocument	getArchivedDocument(long archivedProcessDocumentId)
org.bonitasoft.engine.core.document.model.archive.SAMappedDocument	getArchivedVersionOfProcessDocument(long documentId)
org.bonitasoft.engine.core.document.model.SLightDocument	getDocument(long documentId)
byte[]	getDocumentContent(String documentId)
List<org.bonitasoft.engine.core.document.model.SMappedDocument>	getDocumentList(String documentName, long processInstanceId, int fromIndex, int numberOfResult)
List<org.bonitasoft.engine.core.document.model.SMappedDocument>	getDocumentList(String documentName, long processInstanceId, long time)
List<org.bonitasoft.engine.core.document.model.SMappedDocument>	getDocumentsOfProcessInstance(long processInstanceId, int fromIndex, int numberPerPage, String field, org.bonitasoft.engine.persistence.OrderByType order)
org.bonitasoft.engine.core.document.model.SMappedDocument	getMappedDocument(long mappingId)
org.bonitasoft.engine.core.document.model.SMappedDocument	getMappedDocument(long processInstanceId, String documentName)
org.bonitasoft.engine.core.document.model.SMappedDocument	getMappedDocument(long processInstanceId, String documentName, long time)
long	getNumberOfArchivedDocuments(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
long	getNumberOfArchivedDocumentsSupervisedBy(long userId, org.bonitasoft.engine.persistence.QueryOptions queryOptions)
long	getNumberOfDocuments(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
long	getNumberOfDocumentsOfProcessInstance(long processInstanceId)
long	getNumberOfDocumentsSupervisedBy(long userId, org.bonitasoft.engine.persistence.QueryOptions queryOptions)
void	removeCurrentVersion(long processInstanceId, String documentName)
void	removeCurrentVersion(org.bonitasoft.engine.core.document.model.SMappedDocument document)
void	removeDocument(org.bonitasoft.engine.core.document.model.SMappedDocument mappedDocument)
List<org.bonitasoft.engine.core.document.model.archive.SAMappedDocument>	searchArchivedDocuments(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
List<org.bonitasoft.engine.core.document.model.archive.SAMappedDocument>	searchArchivedDocumentsSupervisedBy(long userId, org.bonitasoft.engine.persistence.QueryOptions queryOptions)
List<org.bonitasoft.engine.core.document.model.SMappedDocument>	searchDocuments(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
List<org.bonitasoft.engine.core.document.model.SMappedDocument>	searchDocumentsSupervisedBy(long userId, org.bonitasoft.engine.persistence.QueryOptions queryOptions)
org.bonitasoft.engine.core.document.model.SMappedDocument	updateDocument(long documentId, org.bonitasoft.engine.core.document.model.SDocument sDocument)
org.bonitasoft.engine.core.document.model.SMappedDocument	updateDocument(org.bonitasoft.engine.core.document.model.SDocumentMapping documentToUpdate, org.bonitasoft.engine.core.document.model.SDocument sDocument)
void	updateDocumentIndex(org.bonitasoft.engine.core.document.model.SMappedDocument mappedDocument, int index)
void	updateDocumentOfList(org.bonitasoft.engine.core.document.model.SMappedDocument mappedDocument, org.bonitasoft.engine.core.document.model.SDocument document, int index)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentServiceImpl

public DocumentServiceImpl(org.bonitasoft.engine.recorder.Recorder recorder,
                   org.bonitasoft.engine.persistence.ReadPersistenceService persistenceService,
                   SDocumentDownloadURLProvider urlProvider,
                   org.bonitasoft.engine.events.EventService eventService,
                   org.bonitasoft.engine.archive.ArchiveService archiveService)

Method Detail

attachDocumentToProcessInstance

public org.bonitasoft.engine.core.document.model.SMappedDocument attachDocumentToProcessInstance(org.bonitasoft.engine.core.document.model.SDocument document,
                                                                                        long processInstanceId,
                                                                                        String name,
                                                                                        String description)
                                                                                          throws org.bonitasoft.engine.commons.exceptions.SObjectCreationException

Specified by:

attachDocumentToProcessInstance in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectCreationException

attachDocumentToProcessInstance

public org.bonitasoft.engine.core.document.model.SMappedDocument attachDocumentToProcessInstance(org.bonitasoft.engine.core.document.model.SDocument document,
                                                                                        long processInstanceId,
                                                                                        String name,
                                                                                        String description,
                                                                                        int index)
                                                                                          throws org.bonitasoft.engine.commons.exceptions.SObjectCreationException,
                                                                                                 org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

Specified by:

attachDocumentToProcessInstance in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectCreationException

org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

updateDocumentOfList

public void updateDocumentOfList(org.bonitasoft.engine.core.document.model.SMappedDocument mappedDocument,
                        org.bonitasoft.engine.core.document.model.SDocument document,
                        int index)
                          throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

updateDocumentOfList in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

updateDocumentIndex

public void updateDocumentIndex(org.bonitasoft.engine.core.document.model.SMappedDocument mappedDocument,
                       int index)
                         throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

updateDocumentIndex in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

deleteDocumentsFromProcessInstance

public void deleteDocumentsFromProcessInstance(Long processInstanceId)
                                        throws org.bonitasoft.engine.persistence.SBonitaReadException,
                                               org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

deleteDocumentsFromProcessInstance in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

generateDocumentURL

public String generateDocumentURL(String name,
                         String contentStorageId)

Specified by:

generateDocumentURL in interface org.bonitasoft.engine.core.document.api.DocumentService

getArchivedDocument

public org.bonitasoft.engine.core.document.model.archive.SAMappedDocument getArchivedDocument(long archivedProcessDocumentId)
                                                                                       throws org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

Specified by:

getArchivedDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

getArchivedVersionOfProcessDocument

public org.bonitasoft.engine.core.document.model.archive.SAMappedDocument getArchivedVersionOfProcessDocument(long documentId)
                                                                                                       throws org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

Specified by:

getArchivedVersionOfProcessDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

getDocument

public org.bonitasoft.engine.core.document.model.SLightDocument getDocument(long documentId)
                                                                     throws org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException,
                                                                            org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

org.bonitasoft.engine.persistence.SBonitaReadException

getMappedDocument

public org.bonitasoft.engine.core.document.model.SMappedDocument getMappedDocument(long processInstanceId,
                                                                          String documentName)
                                                                            throws org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException,
                                                                                   org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getMappedDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

org.bonitasoft.engine.persistence.SBonitaReadException

getMappedDocument

public org.bonitasoft.engine.core.document.model.SMappedDocument getMappedDocument(long processInstanceId,
                                                                          String documentName,
                                                                          long time)
                                                                            throws org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException,
                                                                                   org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getMappedDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

org.bonitasoft.engine.persistence.SBonitaReadException

getDocumentContent

public byte[] getDocumentContent(String documentId)
                          throws org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

Specified by:

getDocumentContent in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

getMappedDocument

public org.bonitasoft.engine.core.document.model.SMappedDocument getMappedDocument(long mappingId)
                                                                            throws org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException,
                                                                                   org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getMappedDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

org.bonitasoft.engine.persistence.SBonitaReadException

getDocumentsOfProcessInstance

public List<org.bonitasoft.engine.core.document.model.SMappedDocument> getDocumentsOfProcessInstance(long processInstanceId,
                                                                                            int fromIndex,
                                                                                            int numberPerPage,
                                                                                            String field,
                                                                                            org.bonitasoft.engine.persistence.OrderByType order)
                                                                                              throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getDocumentsOfProcessInstance in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfArchivedDocuments

public long getNumberOfArchivedDocuments(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                  throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getNumberOfArchivedDocuments in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfArchivedDocumentsSupervisedBy

public long getNumberOfArchivedDocumentsSupervisedBy(long userId,
                                            org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                              throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getNumberOfArchivedDocumentsSupervisedBy in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfDocuments

public long getNumberOfDocuments(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                          throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getNumberOfDocuments in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfDocumentsOfProcessInstance

public long getNumberOfDocumentsOfProcessInstance(long processInstanceId)
                                           throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getNumberOfDocumentsOfProcessInstance in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfDocumentsSupervisedBy

public long getNumberOfDocumentsSupervisedBy(long userId,
                                    org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                      throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getNumberOfDocumentsSupervisedBy in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

removeCurrentVersion

public void removeCurrentVersion(org.bonitasoft.engine.core.document.model.SMappedDocument document)
                          throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

removeCurrentVersion in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

removeCurrentVersion

public void removeCurrentVersion(long processInstanceId,
                        String documentName)
                          throws org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException,
                                 org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

removeCurrentVersion in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

deleteDocument

public void deleteDocument(org.bonitasoft.engine.core.document.model.SLightDocument document)
                    throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

deleteDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

removeDocument

public void removeDocument(org.bonitasoft.engine.core.document.model.SMappedDocument mappedDocument)
                    throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

removeDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

searchArchivedDocuments

public List<org.bonitasoft.engine.core.document.model.archive.SAMappedDocument> searchArchivedDocuments(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                                                                                 throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

searchArchivedDocuments in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchArchivedDocumentsSupervisedBy

public List<org.bonitasoft.engine.core.document.model.archive.SAMappedDocument> searchArchivedDocumentsSupervisedBy(long userId,
                                                                                                           org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                                                                                             throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

searchArchivedDocumentsSupervisedBy in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchDocuments

public List<org.bonitasoft.engine.core.document.model.SMappedDocument> searchDocuments(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                                                                throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

searchDocuments in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchDocumentsSupervisedBy

public List<org.bonitasoft.engine.core.document.model.SMappedDocument> searchDocumentsSupervisedBy(long userId,
                                                                                          org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                                                                            throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

searchDocumentsSupervisedBy in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

deleteArchivedDocuments

public void deleteArchivedDocuments(long instanceId)
                             throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

deleteArchivedDocuments in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

archive

public void archive(org.bonitasoft.engine.core.document.model.SDocumentMapping docMapping,
           long archiveDate)
             throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

archive in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

getDocumentList

public List<org.bonitasoft.engine.core.document.model.SMappedDocument> getDocumentList(String documentName,
                                                                              long processInstanceId,
                                                                              int fromIndex,
                                                                              int numberOfResult)
                                                                                throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getDocumentList in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

deleteContentOfArchivedDocument

public void deleteContentOfArchivedDocument(long documentId)
                                     throws org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException,
                                            org.bonitasoft.engine.persistence.SBonitaReadException,
                                            org.bonitasoft.engine.recorder.SRecorderException

Specified by:

deleteContentOfArchivedDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

org.bonitasoft.engine.persistence.SBonitaReadException

org.bonitasoft.engine.recorder.SRecorderException

updateDocument

public org.bonitasoft.engine.core.document.model.SMappedDocument updateDocument(long documentId,
                                                                       org.bonitasoft.engine.core.document.model.SDocument sDocument)
                                                                         throws org.bonitasoft.engine.persistence.SBonitaReadException,
                                                                                org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException,
                                                                                org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

updateDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

updateDocument

public org.bonitasoft.engine.core.document.model.SMappedDocument updateDocument(org.bonitasoft.engine.core.document.model.SDocumentMapping documentToUpdate,
                                                                       org.bonitasoft.engine.core.document.model.SDocument sDocument)
                                                                         throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

updateDocument in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

getDocumentList

public List<org.bonitasoft.engine.core.document.model.SMappedDocument> getDocumentList(String documentName,
                                                                              long processInstanceId,
                                                                              long time)
                                                                                throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getDocumentList in interface org.bonitasoft.engine.core.document.api.DocumentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException