| 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.
|
boolean |
equals(Object obj) |
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.
|
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 |
getCreator()
Gets the UserId of the task-creator.
|
String |
getCustom1() |
String |
getCustom10() |
String |
getCustom11() |
String |
getCustom12() |
String |
getCustom13() |
String |
getCustom14() |
String |
getCustom15() |
String |
getCustom16() |
String |
getCustom2() |
String |
getCustom3() |
String |
getCustom4() |
String |
getCustom5() |
String |
getCustom6() |
String |
getCustom7() |
String |
getCustom8() |
String |
getCustom9() |
String |
getCustomAttribute(String number)
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 |
getExternalId()
Returns the external id of the task.
|
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.
|
WorkbasketSummaryImpl |
getWorkbasketSummaryImpl() |
int |
hashCode() |
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)
Sets the external business process id.
|
void |
setCallbackInfo(Map<String,String> callbackInfo)
Sets a Map of callback info.
|
void |
setClaimed(java.time.Instant claimed) |
void |
setClassificationCategory(String classificationCategory) |
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 |
setCreator(String creator) |
void |
setCustom1(String custom1) |
void |
setCustom10(String custom10) |
void |
setCustom11(String custom11) |
void |
setCustom12(String custom12) |
void |
setCustom13(String custom13) |
void |
setCustom14(String custom14) |
void |
setCustom15(String custom15) |
void |
setCustom16(String custom16) |
void |
setCustom2(String custom2) |
void |
setCustom3(String custom3) |
void |
setCustom4(String custom4) |
void |
setCustom5(String custom5) |
void |
setCustom6(String custom6) |
void |
setCustom7(String custom7) |
void |
setCustom8(String custom8) |
void |
setCustom9(String custom9) |
void |
setCustomAttribute(String number,
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 |
setDomain(String domain) |
void |
setDue(java.time.Instant due) |
void |
setExternalId(String externalId)
Sets the external Id.
|
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)
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. |
void |
setPriority(int priority) |
void |
setRead(boolean isRead) |
void |
setState(TaskState state) |
void |
setTransferred(boolean isTransferred) |
void |
setWorkbasketKey(String workbasketKey) |
void |
setWorkbasketSummary(WorkbasketSummary workbasket) |
void |
setWorkbasketSummaryImpl(WorkbasketSummaryImpl workbasketSummary) |
String |
toString() |
public String getId()
Taskpublic void setId(String id)
public String getExternalId()
TaskgetExternalId in interface Taskpublic void setExternalId(String externalId)
TasksetExternalId in interface TaskexternalId - the external Idpublic java.time.Instant getCreated()
TaskTaskState.READY.getCreated in interface TaskInstantpublic void setCreated(java.time.Instant created)
public java.time.Instant getClaimed()
TaskTaskState.CLAIMED by/to a user.getClaimed in interface TaskInstantpublic void setClaimed(java.time.Instant claimed)
public java.time.Instant getCompleted()
TaskTaskState.COMPLETED.getCompleted in interface TaskInstantpublic void setCompleted(java.time.Instant completed)
public java.time.Instant getModified()
TaskgetModified in interface TaskInstantpublic void setModified(java.time.Instant modified)
public java.time.Instant getPlanned()
TaskgetPlanned in interface TaskInstantpublic void setPlanned(java.time.Instant planned)
TasksetPlanned in interface Taskplanned - as exact Instantpublic java.time.Instant getDue()
Taskpublic void setDue(java.time.Instant due)
public String getName()
Taskpublic void setName(String name)
Taskpublic void setCreator(String creator)
public String getCreator()
TaskgetCreator in interface Taskpublic String getDescription()
TaskgetDescription in interface Taskpublic void setDescription(String description)
TasksetDescription in interface Taskdescription - the description of the taskpublic String getNote()
Taskpublic void setNote(String note)
Taskpublic int getPriority()
TaskgetPriority in interface Taskpublic void setPriority(int priority)
public TaskState getState()
TaskTaskState of the task.public void setState(TaskState state)
public ClassificationSummary getClassificationSummary()
TaskClassificationSummary of the task.getClassificationSummary in interface Taskpublic void setClassificationKey(String classificationKey)
TaskClassification for this task.setClassificationKey in interface TaskclassificationKey - the classification key for the taskpublic void setClassificationCategory(String classificationCategory)
public String getClassificationCategory()
TaskgetClassificationCategory in interface Taskpublic String getWorkbasketKey()
TaskgetWorkbasketKey in interface Taskpublic void setWorkbasketKey(String workbasketKey)
public WorkbasketSummary getWorkbasketSummary()
TaskgetWorkbasketSummary in interface Taskpublic void setWorkbasketSummary(WorkbasketSummary workbasket)
public String getDomain()
Taskpublic void setDomain(String domain)
public String getBusinessProcessId()
TaskgetBusinessProcessId in interface Taskpublic void setBusinessProcessId(String businessProcessId)
TasksetBusinessProcessId in interface TaskbusinessProcessId - Sets the business process id the task belongs to.public String getParentBusinessProcessId()
TaskgetParentBusinessProcessId in interface Taskpublic void setParentBusinessProcessId(String parentBusinessProcessId)
TasksetParentBusinessProcessId in interface TaskparentBusinessProcessId - Sets the parent business process id the task belongs topublic String getOwner()
Taskpublic void setOwner(String owner)
Taskpublic ObjectReference getPrimaryObjRef()
TaskprimaryObjectReference of the task.getPrimaryObjRef in interface Taskpublic void setPrimaryObjRef(ObjectReference primaryObjRef)
TaskprimaryObjectReference of the task.setPrimaryObjRef in interface TaskprimaryObjRef - to task main-subjectpublic boolean isRead()
Taskpublic void setRead(boolean isRead)
public boolean isTransferred()
TaskisTransferred in interface Taskpublic void setTransferred(boolean isTransferred)
public Map<String,String> getCustomAttributes()
TaskgetCustomAttributes in interface TaskMappublic void setCustomAttributes(Map<String,String> customAttributes)
TasksetCustomAttributes in interface TaskcustomAttributes - a Map that contains the custom attributespublic Map<String,String> getCallbackInfo()
TaskgetCallbackInfo in interface TaskMappublic void setCallbackInfo(Map<String,String> callbackInfo)
TasksetCallbackInfo in interface TaskcallbackInfo - a Map that contains the callback infopublic String getCustomAttribute(String number) throws InvalidArgumentException
TaskgetCustomAttribute in interface Tasknumber - 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"InvalidArgumentException - if num has not a value of "1", "2" ... "16"public void setCustomAttribute(String number, String value) throws InvalidArgumentException
TasksetCustomAttribute in interface Tasknumber - 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 setInvalidArgumentException - if num has not a value of "1", "2" ... "16"public void addAttachment(Attachment attachmentToAdd)
TaskaddAttachment in interface TaskattachmentToAdd - the attachment to be added to the taskpublic List<Attachment> getAttachments()
TaskgetAttachments in interface Tasklist of attachments for this taskpublic TaskSummary asSummary()
Taskpublic void setAttachments(List<Attachment> attachments)
public String getClassificationKey()
public void setClassificationSummary(ClassificationSummary classificationSummary)
public ClassificationSummaryImpl getClassificationSummaryImpl()
public WorkbasketSummaryImpl getWorkbasketSummaryImpl()
public void setWorkbasketSummaryImpl(WorkbasketSummaryImpl workbasketSummary)
public void setClassificationSummaryImpl(ClassificationSummaryImpl classificationSummary)
public String getCustom1()
public void setCustom1(String custom1)
public String getCustom2()
public void setCustom2(String custom2)
public String getCustom3()
public void setCustom3(String custom3)
public String getCustom4()
public void setCustom4(String custom4)
public String getCustom5()
public void setCustom5(String custom5)
public String getCustom6()
public void setCustom6(String custom6)
public String getCustom7()
public void setCustom7(String custom7)
public String getCustom8()
public void setCustom8(String custom8)
public String getCustom9()
public void setCustom9(String custom9)
public String getCustom10()
public void setCustom10(String custom10)
public String getCustom11()
public void setCustom11(String custom11)
public String getCustom12()
public void setCustom12(String custom12)
public String getCustom13()
public void setCustom13(String custom13)
public String getCustom14()
public void setCustom14(String custom14)
public String getCustom15()
public void setCustom15(String custom15)
public String getCustom16()
public void setCustom16(String custom16)
public Attachment removeAttachment(String attachmentId)
TaskTaskService.updateTask(Task).removeAttachment in interface TaskattachmentId - ID of the attachment which should be removed.Copyright © 2019. All rights reserved.