Package pro.taskana.task.api.models
Interface TaskSummary
-
- All Known Subinterfaces:
Task
- All Known Implementing Classes:
TaskImpl,TaskSummaryImpl
public interface TaskSummaryInterface for TaskSummary. This is a specific short model-object which only contains the most important information.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TaskSummarycopy()Duplicates this TaskSummary without the internal and external id.List<AttachmentSummary>getAttachmentSummaries()Gets the attachment summaries of the task.StringgetBusinessProcessId()Gets the businessProcessId of the task.InstantgetClaimed()Gets the time when the task was claimed.ClassificationSummarygetClassificationSummary()Gets the classification summary of the task.InstantgetCompleted()Gets the time when the task was completed.InstantgetCreated()Gets the time when the task was created.StringgetCreator()Gets the name of the task-creator.StringgetCustomAttribute(TaskCustomField customField)Gets the custom attribute of the task.StringgetDescription()Gets the description of the task.StringgetDomain()Gets the domain of the task.InstantgetDue()Gets the time when the task is due.StringgetExternalId()Gets the external id of the task.StringgetId()Gets the id of the task.InstantgetModified()Gets the time when the task was last modified.StringgetName()Gets the name of the task.StringgetNote()Gets the note attached to the task.StringgetOwner()Gets the owner of the task.StringgetParentBusinessProcessId()Gets the parentBusinessProcessId of the task.InstantgetPlanned()Gets the time when the task is planned to be executed.ObjectReferencegetPrimaryObjRef()Gets the primary ObjectReference of the task.intgetPriority()Gets the priority of the task.InstantgetReceived()Gets the time when when the surrounding process was started.TaskStategetState()Gets the state of the task.WorkbasketSummarygetWorkbasketSummary()Gets the workbasket summary of the task.booleanisRead()Gets the isRead flag of the task.booleanisTransferred()Gets the isTransferred flag of the task.
-
-
-
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 task-creator.- 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 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
-
getState
TaskState getState()
Gets the state of the task.- Returns:
- the task's state
-
getClassificationSummary
ClassificationSummary getClassificationSummary()
Gets the classification summary of the task.- Returns:
- the task's classificationSummary
-
getWorkbasketSummary
WorkbasketSummary getWorkbasketSummary()
Gets the workbasket summary of the task.- Returns:
- the task's workbasketSummary
-
getAttachmentSummaries
List<AttachmentSummary> getAttachmentSummaries()
Gets the attachment summaries of the task.- Returns:
- the task's attachment summaries
-
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
-
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.
-
getCustomAttribute
String getCustomAttribute(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
-
-