TaskImpl (pro.taskana:taskana-core 0.0.6 API)

java.lang.Object
- pro.taskana.impl.TaskImpl

All Implemented Interfaces:: Task

public class TaskImpl
extends Object
implements Task

Task entity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttachment(Attachment attachmentToAdd)` Add an attachment. NULL will be ignored and an attachment with the same ID will be replaced by the newer one.
`TaskSummary`	`asSummary()` Return a summary of the current Task.
`List<Attachment>`	`getAttachments()` Return the attachments for this task.
`String`	`getBusinessProcessId()` Returns the businessProcessId of a task.
`java.time.Instant`	`getClaimed()` Returns the time when the task was set to `TaskState.CLAIMED` by/to a user.
`String`	`getClassificationKey()`
`ClassificationSummary`	`getClassificationSummary()` Returns the `ClassificationSummary` of the task.
`ClassificationSummaryImpl`	`getClassificationSummaryImpl()`
`java.time.Instant`	`getCompleted()` Returns the time when the task was set into `TaskState.COMPLETED`.
`java.time.Instant`	`getCreated()` Returns the time when the task was `TaskState.READY`.
`String`	`getCustom1()` Return the value for the 1.
`String`	`getCustom10()` Return the value for the 10.
`String`	`getCustom2()` Return the value for the 2.
`String`	`getCustom3()` Return the value for the 3.
`String`	`getCustom4()` Return the value for the 4.
`String`	`getCustom5()` Return the value for the 5.
`String`	`getCustom6()` Return the value for the 6.
`String`	`getCustom7()` Return the value for the 7.
`String`	`getCustom8()` Return the value for the 8.
`String`	`getCustom9()` Return the value for the 9.
`Map<String,Object>`	`getCustomAttributes()` Returns a collection of customAttributes with a max.
`String`	`getDescription()` Return the task-description.
`String`	`getDomain()` Returns the Domain, to which the Task belongs at this moment.
`java.time.Instant`	`getDue()` Returns the time when this task should be finished.
`String`	`getId()` Returns the current id of the task.
`java.time.Instant`	`getModified()` Returns the time when the task was modified the last time.
`String`	`getName()` Return the name of the current task.
`String`	`getNote()` Returns the custom note for this Task.
`String`	`getOwner()` Return the id of the task-owner.
`String`	`getParentBusinessProcessId()` Returns the parentBusinessProcessId of a task.
`java.time.Instant`	`getPlanned()` Returns the time when the work on this task was planned to be started.
`ObjectReference`	`getPrimaryObjRef()` Returns the `primaryObjectReference` of the task.
`int`	`getPriority()` Returns the numeric priority of a task.
`TaskState`	`getState()` Returns the current `TaskState` of the task.
`String`	`getWorkbasketKey()` Returns the key of the Workbasket where the task is stored in.
`WorkbasketSummary`	`getWorkbasketSummary()` Returns the the Summary of the workbasket where the task is stored in.
`boolean`	`isRead()` Return the isRead-flag, which flags a task as viewed at least one time.
`boolean`	`isTransferred()` Return the isTransferred-flag, which flags a task as transfered into an other workbasket.
`Attachment`	`removeAttachment(String attachmentId)` Removes an attachment of the current task locally, when the ID is represented and does return the removed attachment or null if there was no match. The changed Task need to be updated calling the `TaskService.updateTask(Task)`.
`void`	`setAttachments(List<Attachment> attachments)`
`void`	`setBusinessProcessId(String businessProcessId)`
`void`	`setClaimed(java.time.Instant claimed)`
`void`	`setClassificationKey(String classificationKey)` Sets the Classification key that - together with the Domain from this task's work basket - selects the appropriate `Classification` for this task.
`void`	`setClassificationSummary(ClassificationSummary classificationSummary)`
`void`	`setClassificationSummaryImpl(ClassificationSummaryImpl classificationSummary)`
`void`	`setCompleted(java.time.Instant completed)`
`void`	`setCreated(java.time.Instant created)`
`void`	`setCustom1(String custom1)` Sets the value for customAttribute1.
`void`	`setCustom10(String custom10)` Sets the value for customAttribute10.
`void`	`setCustom2(String custom2)` Sets the value for customAttribute2.
`void`	`setCustom3(String custom3)` Sets the value for customAttribute3.
`void`	`setCustom4(String custom4)` Sets the value for customAttribute4.
`void`	`setCustom5(String custom5)` Sets the value for customAttribute25.
`void`	`setCustom6(String custom6)` Sets the value for customAttribute6.
`void`	`setCustom7(String custom7)` Sets the value for customAttribute7.
`void`	`setCustom8(String custom8)` Sets the value for customAttribute8.
`void`	`setCustom9(String custom9)` Sets the value for customAttribute9.
`void`	`setCustomAttributes(Map<String,Object> customAttributes)`
`void`	`setDescription(String description)` Sets the description of the task.
`void`	`setDomain(String domain)`
`void`	`setDue(java.time.Instant due)`
`void`	`setId(String id)`
`void`	`setModified(java.time.Instant modified)`
`void`	`setName(String name)` Sets the name of the current task.
`void`	`setNote(String note)` Sets/Changing the custom note for this Task.
`void`	`setOwner(String owner)` Sets the ownerId of this task.
`void`	`setParentBusinessProcessId(String parentBusinessProcessId)`
`void`	`setPlanned(java.time.Instant planned)` Sets the time when the work on this task should be started.
`void`	`setPrimaryObjRef(ObjectReference primaryObjRef)` Sets the `primaryObjectReference` of the task.
`void`	`setPriority(int priority)`
`void`	`setRead(boolean isRead)`
`void`	`setState(TaskState state)`
`void`	`setTransferred(boolean isTransferred)`
`void`	`setWorkbasketKey(String workbasketKey)`
`void`	`setWorkbasketSummary(WorkbasketSummary workbasket)`
`String`	`toString()`

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

- Method Detail
  - getId
```
public String getId()
```
    Description copied from interface: Task
    
    Returns the current id of the task.
    
    Specified by:
    
    getId in interface Task
    
    Returns:
    
    taskId
  - setId
```
public void setId(String id)
```
  - getCreated
```
public java.time.Instant getCreated()
```
    Description copied from interface: Task
    
    Returns the time when the task was TaskState.READY.
    
    Specified by:
    
    getCreated in interface Task
    
    Returns:
    
    created as exact Instant
  - setCreated
```
public void setCreated(java.time.Instant created)
```
  - getClaimed
```
public java.time.Instant getClaimed()
```
    Description copied from interface: Task
    
    Returns the time when the task was set to TaskState.CLAIMED by/to a user.
    
    Specified by:
    
    getClaimed in interface Task
    
    Returns:
    
    claimed as exact Instant
  - setClaimed
```
public void setClaimed(java.time.Instant claimed)
```
  - getCompleted
```
public java.time.Instant getCompleted()
```
    Description copied from interface: Task
    
    Returns the time when the task was set into TaskState.COMPLETED.
    
    Specified by:
    
    getCompleted in interface Task
    
    Returns:
    
    completed as exact Instant
  - setCompleted
```
public void setCompleted(java.time.Instant completed)
```
  - getModified
```
public java.time.Instant getModified()
```
    Description copied from interface: Task
    
    Returns the time when the task was modified the last time.
    
    Specified by:
    
    getModified in interface Task
    
    Returns:
    
    modified as exact Instant
  - setModified
```
public void setModified(java.time.Instant modified)
```
  - getPlanned
```
public java.time.Instant getPlanned()
```
    Description copied from interface: Task
    
    Returns the time when the work on this task was planned to be started.
    
    Specified by:
    
    getPlanned in interface Task
    
    Returns:
    
    planned as exact Instant
  - setPlanned
```
public void setPlanned(java.time.Instant planned)
```
    Description copied from interface: Task
    
    Sets the time when the work on this task should be started.
    
    Specified by:
    
    setPlanned in interface Task
    
    Parameters:
    
    planned - as exact Instant
  - getDue
```
public java.time.Instant getDue()
```
    Description copied from interface: Task
    
    Returns the time when this task should be finished.
    
    Specified by:
    
    getDue in interface Task
    
    Returns:
    
    due as exact Instant
  - setDue
```
public void setDue(java.time.Instant due)
```
  - getName
```
public String getName()
```
    Description copied from interface: Task
    
    Return the name of the current task.
    
    Specified by:
    
    getName in interface Task
    
    Returns:
    
    name of the task
  - setName
```
public void setName(String name)
```
    Description copied from interface: Task
    
    Sets the name of the current task.
    
    Specified by:
    
    setName in interface Task
    
    Parameters:
    
    name - the name of the task
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Task
    
    Return the task-description.
    
    Specified by:
    
    getDescription in interface Task
    
    Returns:
    
    description of a task
  - setDescription
```
public void setDescription(String description)
```
    Description copied from interface: Task
    
    Sets the description of the task.
    
    Specified by:
    
    setDescription in interface Task
    
    Parameters:
    
    description - the description of the task
  - getNote
```
public String getNote()
```
    Description copied from interface: Task
    
    Returns the custom note for this Task.
    
    Specified by:
    
    getNote in interface Task
    
    Returns:
    
    the custom note for this TAsk
  - setNote
```
public void setNote(String note)
```
    Description copied from interface: Task
    
    Sets/Changing the custom note for this Task.
    
    Specified by:
    
    setNote in interface Task
    
    Parameters:
    
    note - the custom note for this Task.
  - getPriority
```
public int getPriority()
```
    Description copied from interface: Task
    
    Returns the numeric priority of a task.
    
    Specified by:
    
    getPriority in interface Task
    
    Returns:
    
    priority of the task
  - setPriority
```
public void setPriority(int priority)
```
  - getState
```
public TaskState getState()
```
    Description copied from interface: Task
    
    Returns the current TaskState of the task.
    
    Specified by:
    
    getState in interface Task
    
    Returns:
    
    taskState
  - setState
```
public void setState(TaskState state)
```
  - getClassificationSummary
```
public ClassificationSummary getClassificationSummary()
```
    Description copied from interface: Task
    
    Returns the ClassificationSummary of the task.
    
    Specified by:
    
    getClassificationSummary in interface Task
    
    Returns:
    
    classification summary for the task
  - setClassificationKey
```
public void setClassificationKey(String classificationKey)
```
    Description copied from interface: Task
    
    Sets the Classification key that - together with the Domain from this task's work basket - selects the appropriate Classification for this task.
    
    Specified by:
    
    setClassificationKey in interface Task
    
    Parameters:
    
    classificationKey - the classification key for the task
  - getWorkbasketKey
```
public String getWorkbasketKey()
```
    Description copied from interface: Task
    
    Returns the key of the Workbasket where the task is stored in.
    
    Specified by:
    
    getWorkbasketKey in interface Task
    
    Returns:
    
    workbasketKey
  - setWorkbasketKey
```
public void setWorkbasketKey(String workbasketKey)
```
  - getWorkbasketSummary
```
public WorkbasketSummary getWorkbasketSummary()
```
    Description copied from interface: Task
    
    Returns the the Summary of the workbasket where the task is stored in.
    
    Specified by:
    
    getWorkbasketSummary in interface Task
    
    Returns:
    
    workbasketSummary
  - setWorkbasketSummary
```
public void setWorkbasketSummary(WorkbasketSummary workbasket)
```
  - getDomain
```
public String getDomain()
```
    Description copied from interface: Task
    
    Returns the Domain, to which the Task belongs at this moment.
    
    Specified by:
    
    getDomain in interface Task
    
    Returns:
    
    domain the current domain of the task
  - setDomain
```
public void setDomain(String domain)
```
  - getBusinessProcessId
```
public String getBusinessProcessId()
```
    Description copied from interface: Task
    
    Returns the businessProcessId of a task.
    
    Specified by:
    
    getBusinessProcessId in interface Task
    
    Returns:
    
    businessProcessId
  - setBusinessProcessId
```
public void setBusinessProcessId(String businessProcessId)
```
  - getParentBusinessProcessId
```
public String getParentBusinessProcessId()
```
    Description copied from interface: Task
    
    Returns the parentBusinessProcessId of a task.
    
    Specified by:
    
    getParentBusinessProcessId in interface Task
    
    Returns:
    
    parentBusinessProcessId
  - setParentBusinessProcessId
```
public void setParentBusinessProcessId(String parentBusinessProcessId)
```
  - getOwner
```
public String getOwner()
```
    Description copied from interface: Task
    
    Return the id of the task-owner.
    
    Specified by:
    
    getOwner in interface Task
    
    Returns:
    
    taskOwnerId
  - setOwner
```
public void setOwner(String owner)
```
    Description copied from interface: Task
    
    Sets the ownerId of this task.
    
    Specified by:
    
    setOwner in interface Task
    
    Parameters:
    
    owner - the user id of the task's owner
  - getPrimaryObjRef
```
public ObjectReference getPrimaryObjRef()
```
    Description copied from interface: Task
    
    Returns the primaryObjectReference of the task.
    
    Specified by:
    
    getPrimaryObjRef in interface Task
    
    Returns:
    
    primaryObjRef to task main-subject
  - setPrimaryObjRef
```
public void setPrimaryObjRef(ObjectReference primaryObjRef)
```
    Description copied from interface: Task
    
    Sets the primaryObjectReference of the task.
    
    Specified by:
    
    setPrimaryObjRef in interface Task
    
    Parameters:
    
    primaryObjRef - to task main-subject
  - isRead
```
public boolean isRead()
```
    Description copied from interface: Task
    
    Return the isRead-flag, which flags a task as viewed at least one time.
    
    Specified by:
    
    isRead in interface Task
    
    Returns:
    
    isRead-flag
  - setRead
```
public void setRead(boolean isRead)
```
  - isTransferred
```
public boolean isTransferred()
```
    Description copied from interface: Task
    
    Return the isTransferred-flag, which flags a task as transfered into an other workbasket.
    
    Specified by:
    
    isTransferred in interface Task
    
    Returns:
    
    isTransferred-flag
  - setTransferred
```
public void setTransferred(boolean isTransferred)
```
  - getCustomAttributes
```
public Map<String,Object> getCustomAttributes()
```
    Description copied from interface: Task
    
    Returns a collection of customAttributes with a max. amount of 10 entries.
    
    Specified by:
    
    getCustomAttributes in interface Task
    
    Returns:
    
    customAttributes as Map
  - setCustomAttributes
```
public void setCustomAttributes(Map<String,Object> customAttributes)
```
  - getCustom1
```
public String getCustom1()
```
    Description copied from interface: Task
    
    Return the value for the 1. customAttribute.
    
    Specified by:
    
    getCustom1 in interface Task
    
    Returns:
    
    custom1
  - setCustom1
```
public void setCustom1(String custom1)
```
    Description copied from interface: Task
    
    Sets the value for customAttribute1.
    
    Specified by:
    
    setCustom1 in interface Task
    
    Parameters:
    
    custom1 - the custom1 property of the task
  - getCustom2
```
public String getCustom2()
```
    Description copied from interface: Task
    
    Return the value for the 2. customAttribute.
    
    Specified by:
    
    getCustom2 in interface Task
    
    Returns:
    
    custom2
  - setCustom2
```
public void setCustom2(String custom2)
```
    Description copied from interface: Task
    
    Sets the value for customAttribute2.
    
    Specified by:
    
    setCustom2 in interface Task
    
    Parameters:
    
    custom2 - the custom2 property of the task
  - getCustom3
```
public String getCustom3()
```
    Description copied from interface: Task
    
    Return the value for the 3. customAttribute.
    
    Specified by:
    
    getCustom3 in interface Task
    
    Returns:
    
    custom3
  - setCustom3
```
public void setCustom3(String custom3)
```
    Description copied from interface: Task
    
    Sets the value for customAttribute3.
    
    Specified by:
    
    setCustom3 in interface Task
    
    Parameters:
    
    custom3 - the custom3 property of the task
  - getCustom4
```
public String getCustom4()
```
    Description copied from interface: Task
    
    Return the value for the 4. customAttribute.
    
    Specified by:
    
    getCustom4 in interface Task
    
    Returns:
    
    custom4
  - setCustom4
```
public void setCustom4(String custom4)
```
    Description copied from interface: Task
    
    Sets the value for customAttribute4.
    
    Specified by:
    
    setCustom4 in interface Task
    
    Parameters:
    
    custom4 - the custom4 property of the task
  - getCustom5
```
public String getCustom5()
```
    Description copied from interface: Task
    
    Return the value for the 5. customAttribute.
    
    Specified by:
    
    getCustom5 in interface Task
    
    Returns:
    
    custom5
  - setCustom5
```
public void setCustom5(String custom5)
```
    Description copied from interface: Task
    
    Sets the value for customAttribute25.
    
    Specified by:
    
    setCustom5 in interface Task
    
    Parameters:
    
    custom5 - the custom5 property of the task
  - getCustom6
```
public String getCustom6()
```
    Description copied from interface: Task
    
    Return the value for the 6. customAttribute.
    
    Specified by:
    
    getCustom6 in interface Task
    
    Returns:
    
    custom6
  - setCustom6
```
public void setCustom6(String custom6)
```
    Description copied from interface: Task
    
    Sets the value for customAttribute6.
    
    Specified by:
    
    setCustom6 in interface Task
    
    Parameters:
    
    custom6 - the custom6 property of the task
  - getCustom7
```
public String getCustom7()
```
    Description copied from interface: Task
    
    Return the value for the 7. customAttribute.
    
    Specified by:
    
    getCustom7 in interface Task
    
    Returns:
    
    custom7
  - setCustom7
```
public void setCustom7(String custom7)
```
    Description copied from interface: Task
    
    Sets the value for customAttribute7.
    
    Specified by:
    
    setCustom7 in interface Task
    
    Parameters:
    
    custom7 - the custom7 property of the task
  - getCustom8
```
public String getCustom8()
```
    Description copied from interface: Task
    
    Return the value for the 8. customAttribute.
    
    Specified by:
    
    getCustom8 in interface Task
    
    Returns:
    
    custom8
  - setCustom8
```
public void setCustom8(String custom8)
```
    Description copied from interface: Task
    
    Sets the value for customAttribute8.
    
    Specified by:
    
    setCustom8 in interface Task
    
    Parameters:
    
    custom8 - the custom8 property of the task
  - getCustom9
```
public String getCustom9()
```
    Description copied from interface: Task
    
    Return the value for the 9. customAttribute.
    
    Specified by:
    
    getCustom9 in interface Task
    
    Returns:
    
    custom9
  - setCustom9
```
public void setCustom9(String custom9)
```
    Description copied from interface: Task
    
    Sets the value for customAttribute9.
    
    Specified by:
    
    setCustom9 in interface Task
    
    Parameters:
    
    custom9 - the custom9 property of the task
  - getCustom10
```
public String getCustom10()
```
    Description copied from interface: Task
    
    Return the value for the 10. customAttribute.
    
    Specified by:
    
    getCustom10 in interface Task
    
    Returns:
    
    custom10
  - setCustom10
```
public void setCustom10(String custom10)
```
    Description copied from interface: Task
    
    Sets the value for customAttribute10.
    
    Specified by:
    
    setCustom10 in interface Task
    
    Parameters:
    
    custom10 - the custom10 property of the task
  - addAttachment
```
public void addAttachment(Attachment attachmentToAdd)
```
    Description copied from interface: Task
    
    Add an attachment.
    NULL will be ignored and an attachment with the same ID will be replaced by the newer one.
    
    Specified by:
    
    addAttachment in interface Task
    
    Parameters:
    
    attachmentToAdd - the attachment to be added to the task
  - getAttachments
```
public List<Attachment> getAttachments()
```
    Description copied from interface: Task
    
    Return the attachments for this task.
    Do not use List.add()/addAll() for adding Elements, because it can cause redundant data. Use addAttachment(). Clear() and remove() can be used, because it´s a controllable change.
    
    Specified by:
    
    getAttachments in interface Task
    
    Returns:
    
    the list of attachments for this task
  - asSummary
```
public TaskSummary asSummary()
```
    Description copied from interface: Task
    
    Return a summary of the current Task.
    
    Specified by:
    
    asSummary in interface Task
    
    Returns:
    
    the TaskSummary object for the current task
  - setAttachments
```
public void setAttachments(List<Attachment> attachments)
```
  - getClassificationKey
```
public String getClassificationKey()
```
  - setClassificationSummary
```
public void setClassificationSummary(ClassificationSummary classificationSummary)
```
  - getClassificationSummaryImpl
```
public ClassificationSummaryImpl getClassificationSummaryImpl()
```
  - setClassificationSummaryImpl
```
public void setClassificationSummaryImpl(ClassificationSummaryImpl classificationSummary)
```
  - removeAttachment
```
public Attachment removeAttachment(String attachmentId)
```
    Description copied from interface: Task
    
    Removes an attachment of the current task locally, when the ID is represented and does return the removed attachment or null if there was no match.
    The changed Task need to be updated calling the TaskService.updateTask(Task).
    
    Specified by:
    
    removeAttachment in interface Task
    
    Parameters:
    
    attachmentId - ID of the attachment which should be removed.
    
    Returns:
    
    attachment which will be removed after updating OR null if there was no matching attachment
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TaskImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getId

setId

getCreated

setCreated

getClaimed

setClaimed

getCompleted

setCompleted

getModified

setModified

getPlanned

setPlanned

getDue

setDue

getName

setName

getDescription

setDescription

getNote

setNote

getPriority

setPriority

getState

setState

getClassificationSummary

setClassificationKey

getWorkbasketKey

setWorkbasketKey

getWorkbasketSummary

setWorkbasketSummary

getDomain

setDomain

getBusinessProcessId

setBusinessProcessId

getParentBusinessProcessId

setParentBusinessProcessId

getOwner

setOwner

getPrimaryObjRef

setPrimaryObjRef

isRead

setRead

isTransferred

setTransferred

getCustomAttributes

setCustomAttributes

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

getCustom6

setCustom6

getCustom7

setCustom7

getCustom8

setCustom8

getCustom9

setCustom9

getCustom10

setCustom10

addAttachment

getAttachments

asSummary

setAttachments

getClassificationKey

setClassificationSummary

getClassificationSummaryImpl

setClassificationSummaryImpl

removeAttachment

toString