Package org.nuxeo.ecm.restapi.server.routing

Class TaskObject

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.webengine.model.impl.DefaultObject

org.nuxeo.ecm.restapi.server.PaginableObject<Task>

org.nuxeo.ecm.restapi.server.routing.TaskObject

All Implemented Interfaces:

Resource, Adaptable

public class TaskObject
extends PaginableObject<Task>

Since:

7.2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_QUERY
static final String	PAGE_PROVIDER_NAME
protected String	userId
protected String	workflowInstanceId
protected String	workflowModelName	Deprecated. since 11.1

Fields inherited from class org.nuxeo.ecm.restapi.server.PaginableObject

currentPageIndex, maxResults, offset, pageSize

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor	Description
TaskObject()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	completeTask(String taskId, String action, TaskCompletionRequest taskCompletionRequest)
jakarta.ws.rs.core.Response	delegateTask(String taskId, List<String> delegatedActors, String comment)
protected PageProviderDefinition	getPageProviderDefinition()
protected Object[]	getParams()
Task	getTaskById(String taskId)
List<Task>	getUserRelatedWorkflowTasks()
protected void	initialize(Object... args)
jakarta.ws.rs.core.Response	reassignTask(String taskId, List<String> actors, String comment)

Methods inherited from class org.nuxeo.ecm.restapi.server.PaginableObject

extractLongParam, getPaginableEntries, getPaginableEntries, getSearchDocument

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultObject

disptachAdapter, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

PAGE_PROVIDER_NAME

public static final String PAGE_PROVIDER_NAME

Since:

11.1

See Also:

• Constant Field Values

BASE_QUERY

public static final String BASE_QUERY

userId

protected String userId

workflowInstanceId

protected String workflowInstanceId

workflowModelName

@Deprecated
protected String workflowModelName

Deprecated.

since 11.1

For backward compatibility only. This parameter forces post-filtering and prevents paginated results.

Constructor Details

TaskObject

public TaskObject()

Method Details

initialize

protected void initialize(Object... args)

Overrides:

initialize in class PaginableObject<Task>

reassignTask

@PUT
@Path("{taskId}/reassign")
@Consumes
public jakarta.ws.rs.core.Response reassignTask(@PathParam("taskId")
 String taskId,
 @QueryParam("actors")
 List<String> actors,
 @QueryParam("comment")
 String comment)

delegateTask

@PUT
@Path("{taskId}/delegate")
public jakarta.ws.rs.core.Response delegateTask(@PathParam("taskId")
 String taskId,
 @QueryParam("delegatedActors")
 List<String> delegatedActors,
 @QueryParam("comment")
 String comment)

completeTask

@PUT
@Path("{taskId}/{taskAction}")
public jakarta.ws.rs.core.Response completeTask(@PathParam("taskId")
 String taskId,
 @PathParam("taskAction")
 String action,
 TaskCompletionRequest taskCompletionRequest)

getUserRelatedWorkflowTasks

@GET
public List<Task> getUserRelatedWorkflowTasks()

getTaskById

@GET
@Path("{taskId}")
public Task getTaskById(@PathParam("taskId")
 String taskId)

getPageProviderDefinition

protected PageProviderDefinition getPageProviderDefinition()

Specified by:

getPageProviderDefinition in class PaginableObject<Task>

getParams

protected Object[] getParams()

Overrides:

getParams in class PaginableObject<Task>