Task (Nuxeo ECM Projects 8.10-SNAPSHOT API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

RoutingTask

All Known Implementing Classes:

RoutingTaskImpl, TaskImpl
```
public interface Task
extends Serializable
```
Since:

5.5

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Task.TaskVariableName

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Task.TaskVariableName`

Field Summary

Fields
Modifier and Type Field and Description

static String TASK_PROVIDER_KEY

Fields
Modifier and Type	Field and Description
`static String`	`TASK_PROVIDER_KEY`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addComment(String author, String text)`
`void`	`cancel(CoreSession coreSession)`
`void`	`end(CoreSession coreSession)`
`List<String>`	`getActors()`
`List<TaskComment>`	`getComments()`
`Date`	`getCreated()`
`List<String>`	`getDelegatedActors()`
`String`	`getDescription()`
`String`	`getDirective()`
`DocumentModel`	`getDocument()`
`Date`	`getDueDate()`
`String`	`getId()`
`String`	`getInitiator()`
`String`	`getName()`
`String`	`getProcessId()`
`String`	`getProcessName()`
`String`	`getTargetDocumentId()` Deprecated.
`List<String>`	`getTargetDocumentsIds()`
`String`	`getType()`
`String`	`getVariable(String key)`
`Map<String,String>`	`getVariables()`
`Boolean`	`hasEnded()`
`Boolean`	`isAccepted()`
`Boolean`	`isCancelled()`
`Boolean`	`isOpened()`
`void`	`setAccepted(Boolean accepted)`
`void`	`setActors(List<String> actors)`
`void`	`setCreated(Date created)`
`void`	`setDelegatedActors(List<String> delegatedActors)`
`void`	`setDescription(String description)`
`void`	`setDirective(String directive)`
`void`	`setDueDate(Date dueDate)`
`void`	`setInitiator(String initiator)`
`void`	`setName(String name)`
`void`	`setProcessId(String processId)`
`void`	`setProcessName(String processName)`
`void`	`setTargetDocumentId(String targetDocumentId)` Deprecated.
`void`	`setTargetDocumentsIds(List<String> ids)` The first id on the list is also set as 'targetDocumentId'
`void`	`setType(String type)`
`void`	`setVariable(String key, String value)`
`void`	`setVariables(Map<String,String> variables)`

Field Detail
- TASK_PROVIDER_KEY
```
static final String TASK_PROVIDER_KEY
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values

Method Detail

getDocument
```
DocumentModel getDocument()
```

getId
```
String getId()
```

getTargetDocumentId
```
String getTargetDocumentId()
```
Deprecated.

Since:

5.8, getTargetDocumentsIds() should be used instead

getActors
```
List<String> getActors()
```

getInitiator
```
String getInitiator()
```

getName
```
String getName()
```

getType
```
String getType()
```
Since:

5.6

getProcessId
```
String getProcessId()
```
Since:

5.6

getProcessName
```
String getProcessName()
```
Since:

7.4

getDescription
```
String getDescription()
```

getDirective
```
String getDirective()
```

getComments
```
List<TaskComment> getComments()
```

getVariable
```
String getVariable(String key)
```

getDueDate
```
Date getDueDate()
```

getCreated
```
Date getCreated()
```

isCancelled
```
Boolean isCancelled()
```

isOpened
```
Boolean isOpened()
```

hasEnded
```
Boolean hasEnded()
```

isAccepted
```
Boolean isAccepted()
```

getVariables
```
Map<String,String> getVariables()
```

setActors
```
void setActors(List<String> actors)
```

setInitiator
```
void setInitiator(String initiator)
```

setTargetDocumentId
```
void setTargetDocumentId(String targetDocumentId)
```
Deprecated.

Since:

5.8, setTargetDocumentsIds(List ids) should be used instead

setName
```
void setName(String name)
```

setType
```
void setType(String type)
```
Since:

5.6

setProcessId
```
void setProcessId(String processId)
```
Since:

5.6

setProcessName

void setProcessName(String processName)

Since:: 7.4

setDescription

void setDescription(String description)

setDirective
```
void setDirective(String directive)
```

setVariable

void setVariable(String key,
                 String value)

setDueDate
```
void setDueDate(Date dueDate)
```

setCreated
```
void setCreated(Date created)
```

setAccepted
```
void setAccepted(Boolean accepted)
```

setVariables

void setVariables(Map<String,String> variables)

addComment

void addComment(String author,
                String text)

cancel
```
void cancel(CoreSession coreSession)
```

end
```
void end(CoreSession coreSession)
```

getDelegatedActors
```
List<String> getDelegatedActors()
```
Since:

5.8

setDelegatedActors

void setDelegatedActors(List<String> delegatedActors)

Since:: 5.8

getTargetDocumentsIds
```
List<String> getTargetDocumentsIds()
```
Since:

5.8

setTargetDocumentsIds
```
void setTargetDocumentsIds(List<String> ids)
```
The first id on the list is also set as 'targetDocumentId'

Since:

5.8

Interface Task

Nested Class Summary

Field Summary

Method Summary

Field Detail

TASK_PROVIDER_KEY

Method Detail

getDocument

getId

getTargetDocumentId

getActors

getInitiator

getName

getType

getProcessId

getProcessName

getDescription

getDirective

getComments

getVariable

getDueDate

getCreated

isCancelled

isOpened

hasEnded

isAccepted

getVariables

setActors

setInitiator

setTargetDocumentId

setName

setType

setProcessId

setProcessName

setDescription

setDirective

setVariable

setDueDate

setCreated

setAccepted

setVariables

addComment

cancel

end

getDelegatedActors

setDelegatedActors

getTargetDocumentsIds

setTargetDocumentsIds