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

Class DocumentHelper

java.lang.Object

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

public class DocumentHelper
extends java.lang.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(org.bonitasoft.engine.bpm.document.DocumentValue documentValue, long authorId)
void	createOrUpdateDocument(org.bonitasoft.engine.bpm.document.DocumentValue newValue, java.lang.String documentName, long processInstanceId, long authorId, java.lang.String description)
void	deleteDocument(java.lang.String documentName, long processInstanceId)
java.util.List<SMappedDocument>	getAllDocumentOfTheList(long processInstanceId, java.lang.String name)
boolean	isListDefinedInDefinition(java.lang.String documentName, long processInstanceId)
void	setDocumentList(java.util.List<org.bonitasoft.engine.bpm.document.DocumentValue> documentList, java.lang.String documentName, long processInstanceId, long authorId)
org.bonitasoft.engine.bpm.document.DocumentValue	toCheckedDocumentValue(java.lang.Object newValue)
java.util.List<org.bonitasoft.engine.bpm.document.DocumentValue>	toCheckedList(java.lang.Object newValue)
org.bonitasoft.engine.bpm.document.DocumentValue	toDocumentValue(org.bonitasoft.engine.bpm.document.Document document)
org.bonitasoft.engine.bpm.document.DocumentValue	toDocumentValue(org.bonitasoft.engine.bpm.contract.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 java.util.List<SMappedDocument> getAllDocumentOfTheList(long processInstanceId,
                                                               java.lang.String name)
                                                        throws SBonitaReadException

Throws:

SBonitaReadException

isListDefinedInDefinition

public boolean isListDefinedInDefinition(java.lang.String documentName,
                                         long processInstanceId)
                                  throws SObjectNotFoundException,
                                         SBonitaReadException

Throws:

SObjectNotFoundException

SBonitaReadException

createDocumentObject

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

deleteDocument

public void deleteDocument(java.lang.String documentName,
                           long processInstanceId)
                    throws SObjectModificationException

Throws:

SObjectModificationException

createOrUpdateDocument

public void createOrUpdateDocument(org.bonitasoft.engine.bpm.document.DocumentValue newValue,
                                   java.lang.String documentName,
                                   long processInstanceId,
                                   long authorId,
                                   java.lang.String description)
                            throws SBonitaReadException,
                                   SObjectCreationException,
                                   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

SObjectCreationException

SObjectModificationException

setDocumentList

public void setDocumentList(java.util.List<org.bonitasoft.engine.bpm.document.DocumentValue> documentList,
                            java.lang.String documentName,
                            long processInstanceId,
                            long authorId)
                     throws SBonitaReadException,
                            SObjectCreationException,
                            SObjectNotFoundException,
                            SObjectModificationException,
                            SObjectAlreadyExistsException

Throws:

SBonitaReadException

SObjectCreationException

SObjectNotFoundException

SObjectModificationException

SObjectAlreadyExistsException

toCheckedDocumentValue

public org.bonitasoft.engine.bpm.document.DocumentValue toCheckedDocumentValue(java.lang.Object newValue)
                                                                        throws SOperationExecutionException

Throws:

SOperationExecutionException

toDocumentValue

public org.bonitasoft.engine.bpm.document.DocumentValue toDocumentValue(org.bonitasoft.engine.bpm.contract.FileInputValue fileInput)

toDocumentValue

public org.bonitasoft.engine.bpm.document.DocumentValue toDocumentValue(org.bonitasoft.engine.bpm.document.Document document)
                                                                 throws SOperationExecutionException

Throws:

SOperationExecutionException

toCheckedList

public java.util.List<org.bonitasoft.engine.bpm.document.DocumentValue> toCheckedList(java.lang.Object newValue)
                                                                               throws SOperationExecutionException

Throws:

SOperationExecutionException