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

Class DocumentHelper

java.lang.Object

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

public class DocumentHelper
extends Object

Helper class that set/get/update document on API level (it uses the process definition)

Author:

Baptiste Mesta

Constructor Summary

Constructors

Constructor and Description
DocumentHelper(org.bonitasoft.engine.core.document.api.DocumentService documentService, ProcessDefinitionService processDefinitionService, org.bonitasoft.engine.core.process.instance.api.ProcessInstanceService processInstanceService)

Method Summary

Methods

Modifier and Type	Method and Description
org.bonitasoft.engine.core.document.model.SDocument	createDocumentObject(DocumentValue documentValue, long authorId)
void	createOrUpdateDocument(DocumentValue newValue, String documentName, long processInstanceId, long authorId, String description)
void	deleteDocument(String documentName, long processInstanceId)
List<org.bonitasoft.engine.core.document.model.SMappedDocument>	getAllDocumentOfTheList(long processInstanceId, String name)
boolean	isListDefinedInDefinition(String documentName, long processInstanceId)
void	setDocumentList(List<DocumentValue> documentList, String documentName, long processInstanceId, long authorId)
DocumentValue	toCheckedDocumentValue(Object newValue)
List<DocumentValue>	toCheckedList(Object newValue)
DocumentValue	toDocumentValue(Document document)
DocumentValue	toDocumentValue(FileInputValue fileInput)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentHelper

public DocumentHelper(org.bonitasoft.engine.core.document.api.DocumentService documentService,
              ProcessDefinitionService processDefinitionService,
              org.bonitasoft.engine.core.process.instance.api.ProcessInstanceService processInstanceService)

Method Detail

getAllDocumentOfTheList

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

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

isListDefinedInDefinition

public boolean isListDefinedInDefinition(String documentName,
                                long processInstanceId)
                                  throws org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException,
                                         org.bonitasoft.engine.persistence.SBonitaReadException

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

org.bonitasoft.engine.persistence.SBonitaReadException

createDocumentObject

public org.bonitasoft.engine.core.document.model.SDocument createDocumentObject(DocumentValue documentValue,
                                                                       long authorId)

deleteDocument

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

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

createOrUpdateDocument

public void createOrUpdateDocument(DocumentValue newValue,
                          String documentName,
                          long processInstanceId,
                          long authorId,
                          String description)
                            throws org.bonitasoft.engine.persistence.SBonitaReadException,
                                   org.bonitasoft.engine.commons.exceptions.SObjectCreationException,
                                   org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Parameters:

newValue - the new value

documentName - the name of the document

processInstanceId - the id of the process instance

authorId - the author id

description - used only when creating a document

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectCreationException

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

setDocumentList

public void setDocumentList(List<DocumentValue> documentList,
                   String documentName,
                   long processInstanceId,
                   long authorId)
                     throws org.bonitasoft.engine.persistence.SBonitaReadException,
                            org.bonitasoft.engine.commons.exceptions.SObjectCreationException,
                            org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException,
                            org.bonitasoft.engine.commons.exceptions.SObjectModificationException,
                            org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectCreationException

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

toCheckedDocumentValue

public DocumentValue toCheckedDocumentValue(Object newValue)
                                     throws org.bonitasoft.engine.core.operation.exception.SOperationExecutionException

Throws:

org.bonitasoft.engine.core.operation.exception.SOperationExecutionException

toDocumentValue

public DocumentValue toDocumentValue(FileInputValue fileInput)

toDocumentValue

public DocumentValue toDocumentValue(Document document)
                              throws org.bonitasoft.engine.core.operation.exception.SOperationExecutionException

Throws:

org.bonitasoft.engine.core.operation.exception.SOperationExecutionException

toCheckedList

public List<DocumentValue> toCheckedList(Object newValue)
                                  throws org.bonitasoft.engine.core.operation.exception.SOperationExecutionException

Throws:

org.bonitasoft.engine.core.operation.exception.SOperationExecutionException