AttachmentEntity (Camunda BPM Javadocs 7.11.21-ee)

java.lang.Object
- org.camunda.bpm.engine.impl.persistence.entity.AttachmentEntity

All Implemented Interfaces:: Serializable, DbEntity, HasDbRevision, HistoricEntity, Attachment

public class AttachmentEntity
extends Object
implements Attachment, DbEntity, HasDbRevision, HistoricEntity, Serializable

Author:: Tom Baeyens
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected ByteArrayEntity`	`content`
`protected String`	`contentId`
`protected Date`	`createTime`
`protected String`	`description`
`protected String`	`id`
`protected String`	`name`
`protected String`	`processInstanceId`
`protected Date`	`removalTime`
`protected int`	`revision`
`protected String`	`rootProcessInstanceId`
`protected String`	`taskId`
`protected String`	`tenantId`
`protected String`	`type`
`protected String`	`url`

Constructor Summary

Constructors
Constructor and Description

AttachmentEntity()

Constructors
Constructor and Description
`AttachmentEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteArrayEntity`	`getContent()`
`String`	`getContentId()`
`Date`	`getCreateTime()` The time when the attachment was created.
`String`	`getDescription()` long (max 255 chars) explanation what this attachment is about in context of the task and/or process instance it's linked to.
`String`	`getId()` unique id for this attachment
`String`	`getName()` free user defined short (max 255 chars) name for this attachment
`Object`	`getPersistentState()` Returns a representation of the object, as would be stored in the database.
`String`	`getProcessInstanceId()` reference to the process instance to which this attachment is associated.
`Date`	`getRemovalTime()` The time the historic attachment will be removed.
`int`	`getRevision()`
`int`	`getRevisionNext()`
`String`	`getRootProcessInstanceId()` reference to the root process instance id of the process instance on which this attachment was made
`String`	`getTaskId()` reference to the task to which this attachment is associated.
`String`	`getTenantId()`
`String`	`getType()` indication of the type of content that this attachment refers to.
`String`	`getUrl()` the remote URL in case this is remote content.
`void`	`setContent(ByteArrayEntity content)`
`void`	`setContentId(String contentId)`
`void`	`setCreateTime(Date createTime)`
`void`	`setDescription(String description)` long (max 255 chars) explanation what this attachment is about in context of the task and/or process instance it's linked to.
`void`	`setId(String id)`
`void`	`setName(String name)` free user defined short (max 255 chars) name for this attachment
`void`	`setProcessInstanceId(String processInstanceId)`
`void`	`setRemovalTime(Date removalTime)`
`void`	`setRevision(int revision)`
`void`	`setRootProcessInstanceId(String rootProcessInstanceId)`
`void`	`setTaskId(String taskId)`
`void`	`setTenantId(String tenantId)`
`void`	`setType(String type)`
`void`	`setUrl(String url)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
protected String id
```
  - revision
```
protected int revision
```
  - name
```
protected String name
```
  - description
```
protected String description
```
  - type
```
protected String type
```
  - taskId
```
protected String taskId
```
  - processInstanceId
```
protected String processInstanceId
```
  - url
```
protected String url
```
  - contentId
```
protected String contentId
```
  - content
```
protected ByteArrayEntity content
```
  - tenantId
```
protected String tenantId
```
  - createTime
```
protected Date createTime
```
  - rootProcessInstanceId
```
protected String rootProcessInstanceId
```
  - removalTime
```
protected Date removalTime
```
- Constructor Detail
  - AttachmentEntity
```
public AttachmentEntity()
```
- Method Detail
  - getPersistentState
```
public Object getPersistentState()
```
    Description copied from interface: DbEntity
    
    Returns a representation of the object, as would be stored in the database. Used when deciding if updates have occurred to the object or not since it was last loaded.
    
    Specified by:
    
    getPersistentState in interface DbEntity
  - getRevisionNext
```
public int getRevisionNext()
```
    Specified by:
    
    getRevisionNext in interface HasDbRevision
  - getId
```
public String getId()
```
    Description copied from interface: Attachment
    
    unique id for this attachment
    
    Specified by:
    
    getId in interface DbEntity
    
    Specified by:
    
    getId in interface Attachment
  - setId
```
public void setId(String id)
```
    Specified by:
    
    setId in interface DbEntity
  - getRevision
```
public int getRevision()
```
    Specified by:
    
    getRevision in interface HasDbRevision
  - setRevision
```
public void setRevision(int revision)
```
    Specified by:
    
    setRevision in interface HasDbRevision
  - getName
```
public String getName()
```
    Description copied from interface: Attachment
    
    free user defined short (max 255 chars) name for this attachment
    
    Specified by:
    
    getName in interface Attachment
  - setName
```
public void setName(String name)
```
    Description copied from interface: Attachment
    
    free user defined short (max 255 chars) name for this attachment
    
    Specified by:
    
    setName in interface Attachment
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Attachment
    
    long (max 255 chars) explanation what this attachment is about in context of the task and/or process instance it's linked to.
    
    Specified by:
    
    getDescription in interface Attachment
  - setDescription
```
public void setDescription(String description)
```
    Description copied from interface: Attachment
    
    long (max 255 chars) explanation what this attachment is about in context of the task and/or process instance it's linked to.
    
    Specified by:
    
    setDescription in interface Attachment
  - getType
```
public String getType()
```
    Description copied from interface: Attachment
    
    indication of the type of content that this attachment refers to. Can be mime type or any other indication.
    
    Specified by:
    
    getType in interface Attachment
  - setType
```
public void setType(String type)
```
  - getTaskId
```
public String getTaskId()
```
    Description copied from interface: Attachment
    
    reference to the task to which this attachment is associated.
    
    Specified by:
    
    getTaskId in interface Attachment
  - setTaskId
```
public void setTaskId(String taskId)
```
  - getProcessInstanceId
```
public String getProcessInstanceId()
```
    Description copied from interface: Attachment
    
    reference to the process instance to which this attachment is associated.
    
    Specified by:
    
    getProcessInstanceId in interface Attachment
  - setProcessInstanceId
```
public void setProcessInstanceId(String processInstanceId)
```
  - getUrl
```
public String getUrl()
```
    Description copied from interface: Attachment
    
    the remote URL in case this is remote content. If the attachment content was uploaded with an input stream, then this method returns null and the content can be fetched with TaskService.getAttachmentContent(String).
    
    Specified by:
    
    getUrl in interface Attachment
  - setUrl
```
public void setUrl(String url)
```
  - getContentId
```
public String getContentId()
```
  - setContentId
```
public void setContentId(String contentId)
```
  - getContent
```
public ByteArrayEntity getContent()
```
  - setContent
```
public void setContent(ByteArrayEntity content)
```
  - getTenantId
```
public String getTenantId()
```
  - setTenantId
```
public void setTenantId(String tenantId)
```
  - getCreateTime
```
public Date getCreateTime()
```
    Description copied from interface: Attachment
    
    The time when the attachment was created.
    
    Specified by:
    
    getCreateTime in interface Attachment
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
  - getRootProcessInstanceId
```
public String getRootProcessInstanceId()
```
    Description copied from interface: Attachment
    
    reference to the root process instance id of the process instance on which this attachment was made
    
    Specified by:
    
    getRootProcessInstanceId in interface Attachment
  - getRemovalTime
```
public Date getRemovalTime()
```
    Description copied from interface: Attachment
    
    The time the historic attachment will be removed.
    
    Specified by:
    
    getRemovalTime in interface Attachment
  - setRemovalTime
```
public void setRemovalTime(Date removalTime)
```
  - setRootProcessInstanceId
```
public void setRootProcessInstanceId(String rootProcessInstanceId)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AttachmentEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

revision

name

description

type

taskId

processInstanceId

url

contentId

content

tenantId

createTime

rootProcessInstanceId

removalTime

Constructor Detail

AttachmentEntity

Method Detail

getPersistentState

getRevisionNext

getId

setId

getRevision

setRevision

getName

setName

getDescription

setDescription

getType

setType

getTaskId

setTaskId

getProcessInstanceId

setProcessInstanceId

getUrl

setUrl

getContentId

setContentId

getContent

setContent

getTenantId

setTenantId

getCreateTime

setCreateTime

getRootProcessInstanceId

getRemovalTime

setRemovalTime

setRootProcessInstanceId

toString