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(DocumentService documentService, ProcessDefinitionService processDefinitionService, ProcessInstanceService processInstanceService)

Method Summary

Modifier and Type	Method and Description
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<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(DocumentService documentService,
                      ProcessDefinitionService processDefinitionService,
                      ProcessInstanceService processInstanceService)

Method Detail

getAllDocumentOfTheList

public List<SMappedDocument> getAllDocumentOfTheList(long processInstanceId,
                                                     String name)
                                              throws SBonitaReadException

Throws:

SBonitaReadException

isListDefinedInDefinition

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

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

SBonitaReadException

createDocumentObject

public 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 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:

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 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:

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 SOperationExecutionException

Throws:

SOperationExecutionException

toDocumentValue

public DocumentValue toDocumentValue(FileInputValue fileInput)

toDocumentValue

public DocumentValue toDocumentValue(Document document)
                              throws SOperationExecutionException

Throws:

SOperationExecutionException

toCheckedList

public List<DocumentValue> toCheckedList(Object newValue)
                                  throws SOperationExecutionException

Throws:

SOperationExecutionException