org.bonitasoft.engine.bpm.document

Interface Document

All Superinterfaces:

BaseElement, BonitaObject, NamedElement, Serializable

All Known Subinterfaces:

ArchivedDocument

public interface Document
extends NamedElement, BaseElement

Author:

Nicolas Chabanoles, Matthieu Chaffotte

Method Summary

Modifier and Type	Method and Description
long	getAuthor() Get the username of the user who attached the document to the process instance.
String	getContentFileName() Get the file name of the document.
String	getContentMimeType() Get the mime type of the document's content.
String	getContentStorageId() Get the Id to use to retrieve the document's content.
Date	getCreationDate() Get the date when the document was attached to the process instance.
String	getDescription()
int	getIndex()
long	getProcessInstanceId() Id of the process instance the document is attached to.
String	getUrl() Download URL of the document.
String	getVersion() The version of the document is starting from 1 and is incremented each time a new version is attached
boolean	hasContent() Returns true if he document has content.

Methods inherited from interface org.bonitasoft.engine.bpm.NamedElement

getName

Methods inherited from interface org.bonitasoft.engine.bpm.BaseElement

getId

Method Detail

getProcessInstanceId

long getProcessInstanceId()

Id of the process instance the document is attached to.

getUrl

String getUrl()

Download URL of the document.

hasContent

boolean hasContent()

Returns true if he document has content.

getAuthor

long getAuthor()

Get the username of the user who attached the document to the process instance.

getContentMimeType

String getContentMimeType()

Get the mime type of the document's content.

getContentFileName

String getContentFileName()

Get the file name of the document.

getCreationDate

Date getCreationDate()

Get the date when the document was attached to the process instance.

getContentStorageId

String getContentStorageId()

Get the Id to use to retrieve the document's content.

getDescription

String getDescription()

Returns:

the description of the document

Since:

6.4.0

getVersion

String getVersion()

The version of the document is starting from 1 and is incremented each time a new version is attached

Returns:

the version of the document

Since:

6.4.0

getIndex

int getIndex()