Package pro.taskana.task.api.models

Interface TaskSummary

All Known Subinterfaces:

Task

All Known Implementing Classes:

TaskImpl, TaskSummaryImpl

public interface TaskSummary

Interface for TaskSummary. This is a specific short model-object which only contains the most important information.

Method Summary

Modifier and Type	Method	Description
void	addSecondaryObjectReference(String company, String system, String systemInstance, String type, String value)	Add an ObjectReference to the list of secondary ObjectReferences. NULL will be ignored and an ObjectReference with the same ID will be replaced by the newer one.
void	addSecondaryObjectReference(ObjectReference objectReference)	Add an ObjectReference to the list of secondary ObjectReferences. NULL will be ignored and an ObjectReference with the same ID will be replaced by the newer one.
TaskSummary	copy()	Duplicates this TaskSummary without the internal and external id.
List<AttachmentSummary>	getAttachmentSummaries()	Gets the attachmentSummaries of the Task.
String	getBusinessProcessId()	Gets the businessProcessId of the Task.
Instant	getClaimed()	Gets the time when the Task was claimed.
ClassificationSummary	getClassificationSummary()	Gets the ClassificationSummary of the Task.
Instant	getCompleted()	Gets the time when the Task was completed.
Instant	getCreated()	Gets the time when the task was created.
String	getCreator()	Gets the name of the creator of the Task.
String	getCustomAttribute(TaskCustomField customField)	Deprecated. Use getCustomField(TaskCustomField) instead
String	getCustomField(TaskCustomField customField)	Gets the custom attribute of the task.
String	getDescription()	Gets the description of the Task.
String	getDomain()	Gets the domain of the Task.
Instant	getDue()	Gets the time when the Task is due.
String	getExternalId()	Gets the external id of the Task.
String	getId()	Gets the id of the Task.
int	getManualPriority()	Gets the manualPriority of the Task.
Instant	getModified()	Gets the time when the Task was last modified.
String	getName()	Gets the name of the Task.
String	getNote()	Gets the note attached to the Task.
String	getOwner()	Gets the owner of the Task.
String	getOwnerLongName()	Gets the owner's long name of the Task.
String	getParentBusinessProcessId()	Gets the parentBusinessProcessId of the Task.
Instant	getPlanned()	Gets the time when the Task is planned to be executed.
ObjectReference	getPrimaryObjRef()	Gets the primary ObjectReference of the Task.
int	getPriority()	Gets the priority of the Task.
Instant	getReceived()	Gets the time when the surrounding process was started.
List<ObjectReference>	getSecondaryObjectReferences()	Gets the secondary ObjectReferences of the Task.
TaskState	getState()	Gets the state of the Task.
WorkbasketSummary	getWorkbasketSummary()	Gets the WorkbasketSummary of the Task.
boolean	isManualPriorityActive()	Returns whether the Task is prioritized manually.
boolean	isRead()	Gets the isRead flag of the Task.
boolean	isTransferred()	Gets the isTransferred flag of the Task.
ObjectReference	removeSecondaryObjectReference(String objectReferenceID)	Removes a secondary ObjectReference of the current Task locally, when the ID is represented and does return the removed ObjectReference or null if there was no match.

Method Detail

getId

String getId()

Gets the id of the Task.

Returns:

taskId

getExternalId

String getExternalId()

Gets the external id of the Task.

Returns:

the external Id

getCreator

String getCreator()

Gets the name of the creator of the Task.

Returns:

creator

getCreated

Instant getCreated()

Gets the time when the task was created.

Returns:

the created Instant

getClaimed

Instant getClaimed()

Gets the time when the Task was claimed.

Returns:

the claimed Instant

getCompleted

Instant getCompleted()

Gets the time when the Task was completed.

Returns:

the completed Instant

getModified

Instant getModified()

Gets the time when the Task was last modified.

Returns:

the last modified Instant

getPlanned

Instant getPlanned()

Gets the time when the Task is planned to be executed.

Returns:

the planned Instant

getReceived

Instant getReceived()

Gets the time when the surrounding process was started.

Returns:

the received Instant

getDue

Instant getDue()

Gets the time when the Task is due.

Returns:

the due Instant

getName

String getName()

Gets the name of the Task.

Returns:

the Task's name

getNote

String getNote()

Gets the note attached to the Task.

Returns:

the Task's note

getDescription

String getDescription()

Gets the description of the Task.

Returns:

the Task's description

getPriority

int getPriority()

Gets the priority of the Task.

Returns:

the Task's priority

getManualPriority

int getManualPriority()

Gets the manualPriority of the Task. If the value of manualPriority is zero or greater, the priority is automatically set to manualPriority. In this case, all computations of priority are disabled. If the value of manualPriority is negative, Tasks are not prioritized manually.

Returns:

the manualPriority of the Task

getState

TaskState getState()

Gets the state of the Task.

Returns:

the Task's state

getClassificationSummary

ClassificationSummary getClassificationSummary()

Gets the ClassificationSummary of the Task.

Returns:

the Task's ClassificationSummary

getWorkbasketSummary

WorkbasketSummary getWorkbasketSummary()

Gets the WorkbasketSummary of the Task.

Returns:

the Task's WorkbasketSummary

getAttachmentSummaries

List<AttachmentSummary> getAttachmentSummaries()

Gets the attachmentSummaries of the Task.

Returns:

the Task's attachmentSummaries

getSecondaryObjectReferences

List<ObjectReference> getSecondaryObjectReferences()

Gets the secondary ObjectReferences of the Task.

Returns:

the Task's secondary ObjectReferences

addSecondaryObjectReference

void addSecondaryObjectReference(ObjectReference objectReference)

Add an ObjectReference to the list of secondary ObjectReferences.
NULL will be ignored and an ObjectReference with the same ID will be replaced by the newer one.

Parameters:

objectReference - the secondary objectReference to be added to the Task

addSecondaryObjectReference

void addSecondaryObjectReference(String company,
                                 String system,
                                 String systemInstance,
                                 String type,
                                 String value)

Add an ObjectReference to the list of secondary ObjectReferences.
NULL will be ignored and an ObjectReference with the same ID will be replaced by the newer one.

Parameters:

company - of the objectReference to be added to the Task

system - of the objectReference to be added to the Task

systemInstance - of the objectReference to be added to the Task

type - of the objectReference to be added to the Task

value - of the objectReference to be added to the Task

removeSecondaryObjectReference

ObjectReference removeSecondaryObjectReference(String objectReferenceID)

Removes a secondary ObjectReference of the current Task locally, when the ID is represented and does return the removed ObjectReference or null if there was no match.
The changed Task need to be updated calling the TaskService.updateTask(Task).

Parameters:

objectReferenceID - ID of the ObjectReference which should be removed.

Returns:

the ObjectReference which will be removed after updating OR null if there was no matching ObjectReference

getDomain

String getDomain()

Gets the domain of the Task.

Returns:

the Task's domain

getBusinessProcessId

String getBusinessProcessId()

Gets the businessProcessId of the Task.

Returns:

the Task's businessProcessId

getParentBusinessProcessId

String getParentBusinessProcessId()

Gets the parentBusinessProcessId of the Task.

Returns:

the Task's parentBusinessProcessId

getOwner

String getOwner()

Gets the owner of the Task.

Returns:

the Task's owner

getOwnerLongName

String getOwnerLongName()

Gets the owner's long name of the Task.

Returns:

the long name of the Task owner

getPrimaryObjRef

ObjectReference getPrimaryObjRef()

Gets the primary ObjectReference of the Task.

Returns:

the Task's primary ObjectReference

isRead

boolean isRead()

Gets the isRead flag of the Task.

Returns:

the Task's isRead flag

isTransferred

boolean isTransferred()

Gets the isTransferred flag of the Task.

Returns:

the Task's isTransferred flag.

isManualPriorityActive

boolean isManualPriorityActive()

Returns whether the Task is prioritized manually. That means that the priority is set to the value of the manualPriority of the Task.

Returns:

true, if Tasks are prioritized manually; false otherwise

getCustomAttribute

String getCustomAttribute(TaskCustomField customField)

Deprecated.

Use getCustomField(TaskCustomField) instead

Gets the custom attribute of the Task.

Parameters:

customField - identifies which custom attribute is requested.

Returns:

the value for the given customField

getCustomField

String getCustomField(TaskCustomField customField)

Gets the custom attribute of the task.

Parameters:

customField - identifies which custom attribute is requested.

Returns:

the value for the given customField

copy

TaskSummary copy()

Duplicates this TaskSummary without the internal and external id.

Returns:

a copy of this TaskSummary