org.apache.syncope.common.rest.api.service

Interface UserWorkflowTaskService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

UserWorkflowTaskServiceImpl

@Path(value="flowable/userWorkflowTasks")
public interface UserWorkflowTaskService
extends JAXRSService

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
UserTO	executeNextTask(@NotNull WorkflowTaskExecInput workflowTaskExecInput) Executes the next workflow task available, for matching user key.
List<WorkflowTask>	getAvailableTasks(@NotNull String userKey) Returns a list of available tasks for the given user key.

Method Detail

getAvailableTasks

@GET
 @Path(value="tasks/{userKey}")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<WorkflowTask> getAvailableTasks(@NotNull @PathParam(value="userKey")
                                                                                                                                                      @NotNull String userKey)

Returns a list of available tasks for the given user key.

Parameters:

userKey - user key

Returns:

list of available tasks for the given user key

executeNextTask

@POST
 @Path(value="tasks/{userKey}")
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
UserTO executeNextTask(@NotNull
                                                                                                                                                                                                                     @NotNull WorkflowTaskExecInput workflowTaskExecInput)

Executes the next workflow task available, for matching user key.

Parameters:

workflowTaskExecInput - input for task execution

Returns:

updated user