pro.taskana

Interface Task

All Known Implementing Classes:

TaskImpl

public interface Task

task-Interface to specify attribute interactions.

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.
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	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	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,String>	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	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	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,String> customAttributes) Sets a collection of customAttributes.
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	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

getParentBusinessProcessId

String getParentBusinessProcessId()

Returns the parentBusinessProcessId of a task.

Returns:

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 collection of customAttributes with a max. amount of 10 entries.

Returns:

customAttributes as Map

setCustomAttributes

void setCustomAttributes(Map<String,String> customAttributes)

Sets a collection of customAttributes.

Parameters:

customAttributes - a Map that contains the custom attributes

getCustom1

String getCustom1()

Return the value for the 1. customAttribute.

Returns:

custom1

setCustom1

void setCustom1(String custom1)

Sets the value for customAttribute1.

Parameters:

custom1 - the custom1 property of the task

getCustom2

String getCustom2()

Return the value for the 2. customAttribute.

Returns:

custom2

setCustom2

void setCustom2(String custom2)

Sets the value for customAttribute2.

Parameters:

custom2 - the custom2 property of the task

getCustom3

String getCustom3()

Return the value for the 3. customAttribute.

Returns:

custom3

setCustom3

void setCustom3(String custom3)

Sets the value for customAttribute3.

Parameters:

custom3 - the custom3 property of the task

getCustom4

String getCustom4()

Return the value for the 4. customAttribute.

Returns:

custom4

setCustom4

void setCustom4(String custom4)

Sets the value for customAttribute4.

Parameters:

custom4 - the custom4 property of the task

getCustom5

String getCustom5()

Return the value for the 5. customAttribute.

Returns:

custom5

setCustom5

void setCustom5(String custom5)

Sets the value for customAttribute25.

Parameters:

custom5 - the custom5 property of the task

getCustom6

String getCustom6()

Return the value for the 6. customAttribute.

Returns:

custom6

setCustom6

void setCustom6(String custom6)

Sets the value for customAttribute6.

Parameters:

custom6 - the custom6 property of the task

getCustom7

String getCustom7()

Return the value for the 7. customAttribute.

Returns:

custom7

setCustom7

void setCustom7(String custom7)

Sets the value for customAttribute7.

Parameters:

custom7 - the custom7 property of the task

getCustom8

String getCustom8()

Return the value for the 8. customAttribute.

Returns:

custom8

setCustom8

void setCustom8(String custom8)

Sets the value for customAttribute8.

Parameters:

custom8 - the custom8 property of the task

getCustom9

String getCustom9()

Return the value for the 9. customAttribute.

Returns:

custom9

setCustom9

void setCustom9(String custom9)

Sets the value for customAttribute9.

Parameters:

custom9 - the custom9 property of the task

getCustom10

String getCustom10()

Return the value for the 10. customAttribute.

Returns:

custom10

setCustom10

void setCustom10(String custom10)

Sets the value for customAttribute10.

Parameters:

custom10 - the custom10 property of the task

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