pro.taskana.task.api.models

Interface Task

All Superinterfaces:

TaskSummary

All Known Implementing Classes:

TaskImpl

public interface Task
extends TaskSummary

task-Interface to specify attribute interactions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALLBACK_STATE The key that is used to supply Callback_state within the CallbackInfo map.

Method Summary

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.
Map<String,String>	getCallbackInfo() Returns a Map of Callback info.
String	getClassificationCategory() Returns the category of the current classification.
Map<String,String>	getCustomAttributes() Returns a Map of custom Attributes.
String	getWorkbasketKey() Returns the key of the Workbasket where the task is stored in.
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	setDue(Instant due) Sets the time when the work on this task should be finished.
void	setExternalId(String externalId) Sets the external Id.
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(Instant planned) Sets the time when the work on this task should be started.
void	setPrimaryObjRef(ObjectReference primaryObjRef) Sets the primaryObjectReference of the task.

Methods inherited from interface pro.taskana.task.api.models.TaskSummary

getAttachmentSummaries, getBusinessProcessId, getClaimed, getClassificationSummary, getCompleted, getCreated, getCreator, getCustomAttribute, getDescription, getDomain, getDue, getExternalId, getId, getModified, getName, getNote, getOwner, getParentBusinessProcessId, getPlanned, getPrimaryObjRef, getPriority, getState, getWorkbasketSummary, isRead, isTransferred

Field Detail

CALLBACK_STATE

static final String CALLBACK_STATE

The key that is used to supply Callback_state within the CallbackInfo map. The Callback_state is used predominantly by the taskana adapter. It controls synchronization between taskana and the external system.

See Also:

Constant Field Values

Method Detail

setExternalId

void setExternalId(String externalId)

Sets the external Id. It can be used to correlate the task to a task in an external system. The external Id is enforced to be unique. An attempt to create a task with an existing external Id will be rejected. So, this Id can be used to enforce idempotency of task creation. The externalId can only be set before the task is persisted. Taskana rejects attempts to modify externalId.

Parameters:

externalId - the external Id

setPlanned

void setPlanned(Instant planned)

Sets the time when the work on this task should be started.

Parameters:

planned - as exact Instant

setDue

void setDue(Instant due)

Sets the time when the work on this task should be finished.

Parameters:

due - as exact Instant

setName

void setName(String name)

Sets the name of the current task.

Parameters:

name - the name of the task

setDescription

void setDescription(String description)

Sets the description of the task.

Parameters:

description - the description of 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

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

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

setBusinessProcessId

void setBusinessProcessId(String businessProcessId)

Sets the external business process id.

Parameters:

businessProcessId - Sets the business process id the task belongs to.

setParentBusinessProcessId

void setParentBusinessProcessId(String parentBusinessProcessId)

Sets the parent business process id to group associated processes.

Parameters:

parentBusinessProcessId - Sets the parent business process id the task belongs to

setOwner

void setOwner(String taskOwnerId)

Sets the ownerId of this task.

Parameters:

taskOwnerId - the user id of the task's owner

setPrimaryObjRef

void setPrimaryObjRef(ObjectReference primaryObjRef)

Sets the primaryObjectReference of the task.

Parameters:

primaryObjRef - to task main-subject

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