org.bonitasoft.engine.bpm.document

Class DocumentValue

java.lang.Object

org.bonitasoft.engine.bpm.document.DocumentValue

All Implemented Interfaces:

Serializable

public class DocumentValue
extends Object
implements Serializable

Class that holds a content + mime type and a name OR the url if it's an external document. It is used by DOCUMENT_CREATE_UPDATE operations to create or update a document stored in bonita

Author:

Baptiste Mesta

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentValue(byte[] content, String mimeType, String fileName) Represent the value of a document.
DocumentValue(long documentId) Represent an existing document that did not changed.
DocumentValue(long documentId, byte[] content, String mimeType, String fileName) Represent an existing document that changed with the content and metadata in parameters.
DocumentValue(long documentId, String url) Represent an existing document that changed to an external document.
DocumentValue(String url) Represent the value of an external document, only the url is given

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getContent()
Long	getDocumentId() Indicate which document will be updated Used only when updating list of document
String	getFileName()
int	getIndex()
String	getMimeType()
String	getUrl()
boolean	hasChanged() If the document value updates an existing document, this getter tels us if the content is modified and should be updated
boolean	hasContent()
void	setContent(byte[] content)
void	setDocumentId(Long documentId)
void	setFileName(String fileName)
void	setHasChanged(boolean hasChanged)
void	setHasContent(boolean hasContent)
DocumentValue	setIndex(int index) Index of were to put the document inside the list.
void	setMimeType(String mimeType)
void	setUrl(String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentValue

public DocumentValue(byte[] content,
             String mimeType,
             String fileName)

Represent the value of a document. Content, mime type and file name are given

Parameters:

content - content of the document

mimeType - mime type of the document

fileName - file name of the document

Throws:

IllegalArgumentException - if the content or the fileName is null or empty

DocumentValue

public DocumentValue(String url)

Represent the value of an external document, only the url is given

Parameters:

url - url of the document

DocumentValue

public DocumentValue(long documentId)

Represent an existing document that did not changed. It is used only in operations to update document list.

Parameters:

documentId - the id of the existing document (mapping)

DocumentValue

public DocumentValue(long documentId,
             byte[] content,
             String mimeType,
             String fileName)

Represent an existing document that changed with the content and metadata in parameters. It is used only in operations to update document list.

Parameters:

documentId - the id of the existing document (mapping)

content - content of the document

mimeType - mime type of the document

fileName - file name of the document

Throws:

IllegalArgumentException - if the content or the fileName is null or empty

DocumentValue

public DocumentValue(long documentId,
             String url)

Represent an existing document that changed to an external document. It is used only in operations to update document list.

Parameters:

documentId - the id of the existing document (mapping)

Method Detail

getContent

public byte[] getContent()

getMimeType

public String getMimeType()

getFileName

public String getFileName()

getUrl

public String getUrl()

hasContent

public boolean hasContent()

Returns:

true if the document to create is stored internally or externally with an URL

setContent

public void setContent(byte[] content)

setMimeType

public void setMimeType(String mimeType)

setFileName

public void setFileName(String fileName)

setUrl

public void setUrl(String url)

setHasContent

public void setHasContent(boolean hasContent)

getDocumentId

public Long getDocumentId()

Indicate which document will be updated
Used only when updating list of document

Returns:

the id of the document to update

setDocumentId

public void setDocumentId(Long documentId)

hasChanged

public boolean hasChanged()

If the document value updates an existing document, this getter tels us if the content is modified and should be updated

Returns:

true if the content of the original document has changed

setHasChanged

public void setHasChanged(boolean hasChanged)

getIndex

public int getIndex()

setIndex

public DocumentValue setIndex(int index)

Index of were to put the document inside the list. Only used when using API method attach document.

Parameters:

index - index in the list