pro.taskana

Interface TaskSummary

All Known Implementing Classes:

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 and Description
List<AttachmentSummary>	getAttachmentSummaries() Gets the attachment summaries of the task.
String	getBusinessProcessId() Gets the businessProcessId of the task.
java.time.Instant	getClaimed() Gets the time when the task was claimed.
ClassificationSummary	getClassificationSummary() Gets the classification summary of the task.
java.time.Instant	getCompleted() Gets the time when the task was completed.
java.time.Instant	getCreated() Gets the time when the task was created.
String	getCreator() Gets the name of the task-creator.
String	getCustomAttribute(String num) Gets the custom attribute number num of the task.
String	getDomain() Gets the domain of the task.
java.time.Instant	getDue() Gets the time when the task is due.
String	getExternalId() Gets the external id of the task.
java.time.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	getParentBusinessProcessId() Gets the parentBusinessProcessId of the task.
java.time.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.
TaskState	getState() Gets the state of the task.
String	getTaskId() Gets the id of the task.
WorkbasketSummary	getWorkbasketSummary() Gets the workbasket summary of the task.
boolean	isRead() Gets the isRead flag of the task.
boolean	isTransferred() Gets the isTransferred flag of the task.

Method Detail

getTaskId

String getTaskId()

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

java.time.Instant getCreated()

Gets the time when the task was created.

Returns:

the created Instant

getClaimed

java.time.Instant getClaimed()

Gets the time when the task was claimed.

Returns:

the claimed Instant

getCompleted

java.time.Instant getCompleted()

Gets the time when the task was completed.

Returns:

the completed Instant

getModified

java.time.Instant getModified()

Gets the time when the task was last modified.

Returns:

the last modified Instant

getPlanned

java.time.Instant getPlanned()

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

Returns:

the planned Instant

getDue

java.time.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

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(String num)
                   throws InvalidArgumentException

Gets the custom attribute number num of the task.

Parameters:

num - 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"

Returns:

the value of custom attribute number num

Throws:

InvalidArgumentException - if num has not a value of "1", "2" ... "16"