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.

Field Summary

Fields
Modifier and Type Field Description

static int DEFAULT_MANUAL_PRIORITY

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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()`	Returns the attachmentSummaries of the Task.
`String`	`getBusinessProcessId()`	Returns the businessProcessId of the Task.
`Instant`	`getClaimed()`	Returns the time when the Task was claimed.
`ClassificationSummary`	`getClassificationSummary()`	Returns the ClassificationSummary of the Task.
`Instant`	`getCompleted()`	Returns the time when the Task was completed.
`Instant`	`getCreated()`	Returns the time when the Task was created.
`String`	`getCreator()`	Returns the name of the creator of the Task.
`String`	`getCustomAttribute(TaskCustomField customField)`	Deprecated. Use getCustomField(TaskCustomField) instead
`String`	`getCustomField(TaskCustomField customField)`	Returns the value of the specified TaskCustomField of the Task.
`Integer`	`getCustomIntField(TaskCustomIntField customIntField)`	Returns the value of the specified TaskCustomIntField of the Task.
`String`	`getDescription()`	Returns the description of the Task.
`String`	`getDomain()`	Returns the domain of the Task.
`Instant`	`getDue()`	Returns the time when the Task is due.
`String`	`getExternalId()`	Returns the externalId of the Task.
`Integer`	`getGroupByCount()`	Returns the number of Tasks that are grouped together with this Task by a TaskQuery.
`String`	`getId()`	Returns the id of the Task.
`int`	`getManualPriority()`	Gets the manualPriority of the Task.
`Instant`	`getModified()`	Returns the time when the Task was last modified.
`String`	`getName()`	Returns the name of the Task.
`String`	`getNote()`	Returns the note attached to the Task.
`String`	`getOwner()`	Returns the owner of the Task.
`String`	`getOwnerLongName()`	Returns long name of the owner of the Task.
`String`	`getParentBusinessProcessId()`	Returns the parentBusinessProcessId of the Task.
`Instant`	`getPlanned()`	Returns the time when the Task is planned to be executed.
`ObjectReference`	`getPrimaryObjRef()`	Returns the primary ObjectReference of the Task.
`int`	`getPriority()`	Returns the priority of the Task.
`Instant`	`getReceived()`	Returns the time when the surrounding process was started.
`List<ObjectReference>`	`getSecondaryObjectReferences()`	Returns the secondaryObjectReferences of the Task.
`TaskState`	`getState()`	Returns the state of the Task.
`WorkbasketSummary`	`getWorkbasketSummary()`	Returns the WorkbasketSummary of the Task.
`boolean`	`isManualPriorityActive()`	Returns whether the Task is prioritized manually.
`boolean`	`isRead()`	Returns the isRead flag of the Task.
`boolean`	`isTransferred()`	Returns 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.

- Field Detail
  - DEFAULT_MANUAL_PRIORITY
```
static final int DEFAULT_MANUAL_PRIORITY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
String getId()
```
    Returns the id of the Task.
    
    Returns:
    
    taskId
  - getExternalId
```
String getExternalId()
```
    Returns the externalId of the Task.
    
    Returns:
    
    externalId
  - getCreator
```
String getCreator()
```
    Returns the name of the creator of the Task.
    
    Returns:
    
    creator
  - getCreated
```
Instant getCreated()
```
    Returns the time when the Task was created.
    
    Returns:
    
    the created Instant
  - getClaimed
```
Instant getClaimed()
```
    Returns the time when the Task was claimed.
    
    Returns:
    
    the claimed Instant
  - getCompleted
```
Instant getCompleted()
```
    Returns the time when the Task was completed.
    
    Returns:
    
    the completed Instant
  - getModified
```
Instant getModified()
```
    Returns the time when the Task was last modified.
    
    Returns:
    
    the last modified Instant
  - getPlanned
```
Instant getPlanned()
```
    Returns the time when the Task is planned to be executed.
    
    Returns:
    
    the planned Instant
  - getReceived
```
Instant getReceived()
```
    Returns the time when the surrounding process was started.
    
    Returns:
    
    the received Instant
  - getGroupByCount
```
Integer getGroupByCount()
```
    Returns the number of Tasks that are grouped together with this Task by a TaskQuery. It's only not NULL when using TaskQuery.groupByPor() or TaskQuery.groupBySor(String).
    
    Returns:
    
    the number of Tasks grouped toghether with this Task
  - getDue
```
Instant getDue()
```
    Returns the time when the Task is due.
    This instant denotes the last point in the allowed work time has ended or in short it is inclusive.
    
    Returns:
    
    the due Instant
  - getName
```
String getName()
```
    Returns the name of the Task.
    
    Returns:
    
    name
  - getNote
```
String getNote()
```
    Returns the note attached to the Task.
    
    Returns:
    
    note
  - getDescription
```
String getDescription()
```
    Returns the description of the Task.
    
    Returns:
    
    description
  - getPriority
```
int getPriority()
```
    Returns the priority of the Task.
    
    Returns:
    
    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()
```
    Returns the state of the Task.
    
    Returns:
    
    state
  - getClassificationSummary
```
ClassificationSummary getClassificationSummary()
```
    Returns the ClassificationSummary of the Task.
    
    Returns:
    
    ClassificationSummary
  - getWorkbasketSummary
```
WorkbasketSummary getWorkbasketSummary()
```
    Returns the WorkbasketSummary of the Task.
    
    Returns:
    
    WorkbasketSummary
  - getAttachmentSummaries
```
List<AttachmentSummary> getAttachmentSummaries()
```
    Returns the attachmentSummaries of the Task.
    
    Returns:
    
    attachmentSummaries
  - getSecondaryObjectReferences
```
List<ObjectReference> getSecondaryObjectReferences()
```
    Returns the secondaryObjectReferences of the Task.
    
    Returns:
    
    secondaryObjectReferences
  - 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()
```
    Returns the domain of the Task.
    
    Returns:
    
    domain
  - getBusinessProcessId
```
String getBusinessProcessId()
```
    Returns the businessProcessId of the Task.
    
    Returns:
    
    businessProcessId
  - getParentBusinessProcessId
```
String getParentBusinessProcessId()
```
    Returns the parentBusinessProcessId of the Task.
    
    Returns:
    
    parentBusinessProcessId
  - getOwner
```
String getOwner()
```
    Returns the owner of the Task.
    
    Returns:
    
    owner
  - getOwnerLongName
```
String getOwnerLongName()
```
    Returns long name of the owner of the Task.
    
    Returns:
    
    the long name of the owner
  - getPrimaryObjRef
```
ObjectReference getPrimaryObjRef()
```
    Returns the primary ObjectReference of the Task.
    
    Returns:
    
    the Tasks primary ObjectReference
  - isRead
```
boolean isRead()
```
    Returns the isRead flag of the Task.
    
    Returns:
    
    the Tasks isRead flag
  - isTransferred
```
boolean isTransferred()
```
    Returns the isTransferred flag of the Task.
    
    Returns:
    
    the Tasks 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
```
@Deprecated
String getCustomAttribute(TaskCustomField customField)
```
    Deprecated.
    Use getCustomField(TaskCustomField) instead
    
    Returns the value of the specified TaskCustomField of the Task.
    
    Parameters:
    
    customField - identifies which TaskCustomField is requested
    
    Returns:
    
    the value for the given customField
  - getCustomField
```
String getCustomField(TaskCustomField customField)
```
    Returns the value of the specified TaskCustomField of the Task.
    
    Parameters:
    
    customField - identifies which TaskCustomField is requested
    
    Returns:
    
    the value for the given TaskCustomField
  - getCustomIntField
```
Integer getCustomIntField(TaskCustomIntField customIntField)
```
    Returns the value of the specified TaskCustomIntField of the Task.
    
    Parameters:
    
    customIntField - identifies which TaskCustomIntField is requested
    
    Returns:
    
    the value for the given TaskCustomIntField
  - copy
```
TaskSummary copy()
```
    Duplicates this TaskSummary without the internal and external id.
    
    Returns:
    
    a copy of this TaskSummary

Interface TaskSummary

Field Summary

Method Summary

Field Detail

DEFAULT_MANUAL_PRIORITY

Method Detail

getId

getExternalId

getCreator

getCreated

getClaimed

getCompleted

getModified

getPlanned

getReceived

getGroupByCount

getDue

getName

getNote

getDescription

getPriority

getManualPriority

getState

getClassificationSummary

getWorkbasketSummary

getAttachmentSummaries

getSecondaryObjectReferences

addSecondaryObjectReference

addSecondaryObjectReference

removeSecondaryObjectReference

getDomain

getBusinessProcessId

getParentBusinessProcessId

getOwner

getOwnerLongName

getPrimaryObjRef

isRead

isTransferred

isManualPriorityActive

getCustomAttribute

getCustomField

getCustomIntField

copy