org.nuxeo.ecm.platform.task

Interface Task

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	TASK_PROVIDER_KEY

Method Summary

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	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	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()
                       throws ClientException

Throws:

ClientException

getInitiator

String getInitiator()
                    throws ClientException

Throws:

ClientException

getName

String getName()
               throws ClientException

Throws:

ClientException

getType

String getType()
               throws ClientException

Throws:

ClientException

Since:

5.6

getProcessId

String getProcessId()
                    throws ClientException

Throws:

ClientException

Since:

5.6

getDescription

String getDescription()
                      throws ClientException

Throws:

ClientException

getDirective

String getDirective()
                    throws ClientException

Throws:

ClientException

getComments

List<TaskComment> getComments()
                              throws ClientException

Throws:

ClientException

getVariable

String getVariable(String key)
                   throws ClientException

Throws:

ClientException

getDueDate

Date getDueDate()
                throws ClientException

Throws:

ClientException

getCreated

Date getCreated()
                throws ClientException

Throws:

ClientException

isCancelled

Boolean isCancelled()
                    throws ClientException

Throws:

ClientException

isOpened

Boolean isOpened()
                 throws ClientException

Throws:

ClientException

hasEnded

Boolean hasEnded()
                 throws ClientException

Throws:

ClientException

isAccepted

Boolean isAccepted()
                   throws ClientException

Throws:

ClientException

getVariables

Map<String,String> getVariables()
                                throws ClientException

Throws:

ClientException

setActors

void setActors(List<String> actors)
               throws ClientException

Throws:

ClientException

setInitiator

void setInitiator(String initiator)
                  throws ClientException

Throws:

ClientException

setTargetDocumentId

void setTargetDocumentId(String targetDocumentId)
                         throws ClientException

Deprecated.

Throws:

ClientException

Since:

5.8, setTargetDocumentsIds(List ids) should be used instead

setName

void setName(String name)
             throws ClientException

Throws:

ClientException

setType

void setType(String type)
             throws ClientException

Throws:

ClientException

Since:

5.6

setProcessId

void setProcessId(String processId)
                  throws ClientException

Throws:

ClientException

Since:

5.6

setDescription

void setDescription(String description)
                    throws ClientException

Throws:

ClientException

setDirective

void setDirective(String directive)
                  throws ClientException

Throws:

ClientException

setVariable

void setVariable(String key,
               String value)
                 throws ClientException

Throws:

ClientException

setDueDate

void setDueDate(Date dueDate)
                throws ClientException

Throws:

ClientException

setCreated

void setCreated(Date created)
                throws ClientException

Throws:

ClientException

setAccepted

void setAccepted(Boolean accepted)
                 throws ClientException

Throws:

ClientException

setVariables

void setVariables(Map<String,String> variables)
                  throws ClientException

Throws:

ClientException

addComment

void addComment(String author,
              String text)
                throws ClientException

Throws:

ClientException

cancel

void cancel(CoreSession coreSession)
            throws ClientException

Throws:

ClientException

end

void end(CoreSession coreSession)
         throws ClientException

Throws:

ClientException

getDelegatedActors

List<String> getDelegatedActors()
                                throws ClientException

Throws:

ClientException

Since:

5.8

setDelegatedActors

void setDelegatedActors(List<String> delegatedActors)

Since:

5.8

getTargetDocumentsIds

List<String> getTargetDocumentsIds()
                                   throws ClientException

Throws:

ClientException

Since:

5.8

setTargetDocumentsIds

void setTargetDocumentsIds(List<String> ids)
                           throws ClientException

The first id on the list is also set as 'targetDocumentId'

Throws:

ClientException

Since:

5.8