Task (pro.taskana:taskana-core 0.9.0 API)

All Known Implementing Classes:

TaskImpl
```
public interface Task
```
task-Interface to specify attribute interactions.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addAttachment(Attachment attachment)` 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.
`Map<String,String>`	`getCallbackInfo()` Returns a Map of Callback info.
`java.time.Instant`	`getClaimed()` Returns the time when the task was set to `TaskState.CLAIMED` by/to a user.
`String`	`getClassificationCategory()` Returns the category of the current classification.
`ClassificationSummary`	`getClassificationSummary()` Returns the `ClassificationSummary` of the task.
`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`	`getCreator()` Gets the UserId of the task-creator.
`String`	`getCustomAttribute(String num)` Return the value for custom Attribute number num.
`Map<String,String>`	`getCustomAttributes()` Returns a Map of custom Attributes.
`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`	`setBusinessProcessId(String businessProcessId)` Sets the external business process id.
`void`	`setCallbackInfo(Map<String,String> callbackInfo)` Sets a Map of callback info.
`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`	`setCustomAttribute(String num, String value)` Sets the value for custom Attribute number num.
`void`	`setCustomAttributes(Map<String,String> customAttributes)` Sets a Map of custom Attributes.
`void`	`setDescription(String description)` Sets the description of the task.
`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 taskOwnerId)` Sets the ownerId of this task.
`void`	`setParentBusinessProcessId(String parentBusinessProcessId)` Sets the parent business process id to group associated processes.
`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.

- Method Detail
  - getId
```
String getId()
```
    Returns the current id of the task.
    
    Returns:
    
    taskId
  - getCreator
```
String getCreator()
```
    Gets the UserId of the task-creator.
    
    Returns:
    
    creator
  - getCreated
```
java.time.Instant getCreated()
```
    Returns the time when the task was TaskState.READY.
    
    Returns:
    
    created as exact Instant
  - getClaimed
```
java.time.Instant getClaimed()
```
    Returns the time when the task was set to TaskState.CLAIMED by/to a user.
    
    Returns:
    
    claimed as exact Instant
  - getCompleted
```
java.time.Instant getCompleted()
```
    Returns the time when the task was set into TaskState.COMPLETED.
    
    Returns:
    
    completed as exact Instant
  - getModified
```
java.time.Instant getModified()
```
    Returns the time when the task was modified the last time.
    
    Returns:
    
    modified as exact Instant
  - getPlanned
```
java.time.Instant getPlanned()
```
    Returns the time when the work on this task was planned to be started.
    
    Returns:
    
    planned as exact Instant
  - setPlanned
```
void setPlanned(java.time.Instant planned)
```
    Sets the time when the work on this task should be started.
    
    Parameters:
    
    planned - as exact Instant
  - getDue
```
java.time.Instant getDue()
```
    Returns the time when this task should be finished.
    
    Returns:
    
    due as exact Instant
  - getName
```
String getName()
```
    Return the name of the current task.
    
    Returns:
    
    name of the task
  - setName
```
void setName(String name)
```
    Sets the name of the current task.
    
    Parameters:
    
    name - the name of the task
  - getDescription
```
String getDescription()
```
    Return the task-description.
    
    Returns:
    
    description of a task
  - setDescription
```
void setDescription(String description)
```
    Sets the description of the task.
    
    Parameters:
    
    description - the description of the task
  - getPriority
```
int getPriority()
```
    Returns the numeric priority of a task.
    
    Returns:
    
    priority of the task
  - getState
```
TaskState getState()
```
    Returns the current TaskState of the task.
    
    Returns:
    
    taskState
  - getClassificationSummary
```
ClassificationSummary getClassificationSummary()
```
    Returns the ClassificationSummary of the task.
    
    Returns:
    
    classification summary for the task
  - setClassificationKey
```
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.
    
    Parameters:
    
    classificationKey - the classification key for the task
  - getWorkbasketKey
```
String getWorkbasketKey()
```
    Returns the key of the Workbasket where the task is stored in.
    
    Returns:
    
    workbasketKey
  - getWorkbasketSummary
```
WorkbasketSummary getWorkbasketSummary()
```
    Returns the the Summary of the workbasket where the task is stored in.
    
    Returns:
    
    workbasketSummary
  - getDomain
```
String getDomain()
```
    Returns the Domain, to which the Task belongs at this moment.
    
    Returns:
    
    domain the current domain of the task
  - getBusinessProcessId
```
String getBusinessProcessId()
```
    Returns the businessProcessId of a task.
    
    Returns:
    
    businessProcessId
  - setBusinessProcessId
```
void setBusinessProcessId(String businessProcessId)
```
    Sets the external business process id.
    
    Parameters:
    
    businessProcessId -
  - getParentBusinessProcessId
```
String getParentBusinessProcessId()
```
    Returns the parentBusinessProcessId of a task.
    
    Returns:
    
    parentBusinessProcessId
  - setParentBusinessProcessId
```
void setParentBusinessProcessId(String parentBusinessProcessId)
```
    Sets the parent business process id to group associated processes.
    
    Parameters:
    
    parentBusinessProcessId -
  - getOwner
```
String getOwner()
```
    Return the id of the task-owner.
    
    Returns:
    
    taskOwnerId
  - setOwner
```
void setOwner(String taskOwnerId)
```
    Sets the ownerId of this task.
    
    Parameters:
    
    taskOwnerId - the user id of the task's owner
  - getPrimaryObjRef
```
ObjectReference getPrimaryObjRef()
```
    Returns the primaryObjectReference of the task.
    
    Returns:
    
    primaryObjRef to task main-subject
  - setPrimaryObjRef
```
void setPrimaryObjRef(ObjectReference primaryObjRef)
```
    Sets the primaryObjectReference of the task.
    
    Parameters:
    
    primaryObjRef - to task main-subject
  - isRead
```
boolean isRead()
```
    Return the isRead-flag, which flags a task as viewed at least one time.
    
    Returns:
    
    isRead-flag
  - isTransferred
```
boolean isTransferred()
```
    Return the isTransferred-flag, which flags a task as transfered into an other workbasket.
    
    Returns:
    
    isTransferred-flag
  - getCustomAttributes
```
Map<String,String> getCustomAttributes()
```
    Returns a Map of custom Attributes.
    
    Returns:
    
    customAttributes as Map
  - setCustomAttributes
```
void setCustomAttributes(Map<String,String> customAttributes)
```
    Sets a Map of custom Attributes.
    
    Parameters:
    
    customAttributes - a Map that contains the custom attributes
  - getCallbackInfo
```
Map<String,String> getCallbackInfo()
```
    Returns a Map of Callback info.
    
    Returns:
    
    callbackInfo as Map
  - setCallbackInfo
```
void setCallbackInfo(Map<String,String> callbackInfo)
```
    Sets a Map of callback info.
    
    Parameters:
    
    callbackInfo - a Map that contains the callback info
  - getCustomAttribute
```
String getCustomAttribute(String num)
                   throws InvalidArgumentException
```
    Return the value for custom Attribute number num.
    
    Parameters:
    
    num - identifies which custom attribute is requested. Taskana concatenates "custom_" with num and the resulting String must match the name of the database column that contains the custom attribute. Valid values are "1", "2" .. "16"
    
    Returns:
    
    the value of custom attribute number num
    
    Throws:
    
    InvalidArgumentException - if num has not a value of "1", "2" ... "16"
  - setCustomAttribute
```
void setCustomAttribute(String num,
                        String value)
                 throws InvalidArgumentException
```
    Sets the value for custom Attribute number num.
    
    Parameters:
    
    num - identifies which custom attribute is to be set. Taskana concatenates "custom_" with num and the resulting String must match the name of the database column that contains the custom attribute. Valid values are "1", "2" .. "16"
    
    value - the value of the custom attribute to be set
    
    Throws:
    
    InvalidArgumentException - if num has not a value of "1", "2" ... "16"
  - addAttachment
```
void addAttachment(Attachment attachment)
```
    Add an attachment.
    NULL will be ignored and an attachment with the same ID will be replaced by the newer one.
    
    Parameters:
    
    attachment - the attachment to be added to the task
  - getAttachments
```
List<Attachment> getAttachments()
```
    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.
    
    Returns:
    
    the list of attachments for this task
  - getNote
```
String getNote()
```
    Returns the custom note for this Task.
    
    Returns:
    
    the custom note for this TAsk
  - setNote
```
void setNote(String note)
```
    Sets/Changing the custom note for this Task.
    
    Parameters:
    
    note - the custom note for this Task.
  - asSummary
```
TaskSummary asSummary()
```
    Return a summary of the current Task.
    
    Returns:
    
    the TaskSummary object for the current task
  - removeAttachment
```
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).
    
    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
  - getClassificationCategory
```
String getClassificationCategory()
```
    Returns the category of the current classification.
    
    Returns:
    
    classificationCategory

Interface Task

Method Summary

Method Detail

getId

getCreator

getCreated

getClaimed

getCompleted

getModified

getPlanned

setPlanned

getDue

getName

setName

getDescription

setDescription

getPriority

getState

getClassificationSummary

setClassificationKey

getWorkbasketKey

getWorkbasketSummary

getDomain

getBusinessProcessId

setBusinessProcessId

getParentBusinessProcessId

setParentBusinessProcessId

getOwner

setOwner

getPrimaryObjRef

setPrimaryObjRef

isRead

isTransferred

getCustomAttributes

setCustomAttributes

getCallbackInfo

setCallbackInfo

getCustomAttribute

setCustomAttribute

addAttachment

getAttachments

getNote

setNote

asSummary

removeAttachment

getClassificationCategory