com.edorasware.publicapi.rest

Class TaskController

java.lang.Object

com.edorasware.publicapi.rest.TaskController

@ApiController
public class TaskController
extends Object

This class implements Task specific public API methods

Constructor Summary

Constructors

Constructor and Description
TaskController(TaskManager taskManager, WorkObjectManager workObjectManager, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
void	complete(String workObjectId, String view, List<String> fields, Map<String,String> valueMap)
ValueMap	create(String data, String view, List<String> fields)
void	delete(String workObjectId)
QueryResponse	get(String query, Integer start, Integer size, String view, List<String> fields)
ValueMap	getInstance(String ambiguousWorkObjectId, String view, List<String> fields)
QueryResponse	getProcessItems(String workObjectId, String query, Integer start, Integer size, String view, List<String> fields)
Map<String,Object>	getTaskWorkForm(String ambiguousWorkObjectId, Locale locale)
void	options(javax.servlet.http.HttpServletResponse response)
ValueMap	update(String workObjectId, String data, String view, List<String> fields)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskController

@Autowired
public TaskController(TaskManager taskManager,
                                 WorkObjectManager workObjectManager,
                                 @Qualifier(value="publicApiObjectMapper")
                                 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Detail

get

@RequestMapping(value={"/tasks","/v1/tasks"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse get(@RequestParam(required=false)
                                                                                                                                                               String query,
                                                                                                                                                               @RequestParam(required=false)
                                                                                                                                                               Integer start,
                                                                                                                                                               @RequestParam(required=false,defaultValue="50")
                                                                                                                                                               Integer size,
                                                                                                                                                               @RequestParam(required=false)
                                                                                                                                                               String view,
                                                                                                                                                               @RequestParam(required=false)
                                                                                                                                                               List<String> fields)

getInstance

@RequestMapping(value={"/tasks/{ambiguousWorkObjectId}","/v1/tasks/{ambiguousWorkObjectId}"},
                method=GET,
                produces="application/json")
 @ResponseBody
public ValueMap getInstance(@PathVariable
                                                                                                                                                                                                                  String ambiguousWorkObjectId,
                                                                                                                                                                                                                  @RequestParam(required=false)
                                                                                                                                                                                                                  String view,
                                                                                                                                                                                                                  @RequestParam(required=false)
                                                                                                                                                                                                                  List<String> fields)

getProcessItems

@RequestMapping(value={"/tasks/{workObjectId}/workobjects","/v1/tasks/{workObjectId}/workobjects"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse getProcessItems(@PathVariable
                                                                                                                                                                                                                                 String workObjectId,
                                                                                                                                                                                                                                 @RequestParam(required=false,defaultValue="state:open sort:creation:desc")
                                                                                                                                                                                                                                 String query,
                                                                                                                                                                                                                                 @RequestParam(required=false)
                                                                                                                                                                                                                                 Integer start,
                                                                                                                                                                                                                                 @RequestParam(required=false,defaultValue="50")
                                                                                                                                                                                                                                 Integer size,
                                                                                                                                                                                                                                 @RequestParam(required=false)
                                                                                                                                                                                                                                 String view,
                                                                                                                                                                                                                                 @RequestParam(required=false)
                                                                                                                                                                                                                                 List<String> fields)

create

@RequestMapping(value={"/tasks","/v1/tasks"},
                method=POST,
                produces="application/json",
                consumes="application/json")
 @ResponseBody
public ValueMap create(@RequestBody
                                                                                                                                                                                                           String data,
                                                                                                                                                                                                           @RequestParam(required=false)
                                                                                                                                                                                                           String view,
                                                                                                                                                                                                           @RequestParam(required=false)
                                                                                                                                                                                                           List<String> fields)
                                                                                                                                                                                                    throws IOException

Throws:

IOException

update

@RequestMapping(value={"/tasks/{workObjectId}","/v1/tasks/{workObjectId}"},
                method=PUT,
                produces="application/json",
                consumes="application/json")
 @ResponseBody
public ValueMap update(@PathVariable
                                                                                                                                                                                                                                        String workObjectId,
                                                                                                                                                                                                                                        @RequestBody
                                                                                                                                                                                                                                        String data,
                                                                                                                                                                                                                                        @RequestParam(required=false)
                                                                                                                                                                                                                                        String view,
                                                                                                                                                                                                                                        @RequestParam(required=false)
                                                                                                                                                                                                                                        List<String> fields)
                                                                                                                                                                                                                                 throws IOException

Throws:

IOException

getTaskWorkForm

@RequestMapping(value={"/tasks/{ambiguousWorkObjectId}/work-form","/v1/tasks/{ambiguousWorkObjectId}/work-form"},
                method=GET,
                produces="application/json")
 @ResponseBody
public Map<String,Object> getTaskWorkForm(@PathVariable
                                                                                                                                                                                                                                                    String ambiguousWorkObjectId,
                                                                                                                                                                                                                                                    Locale locale)

delete

@RequestMapping(value={"/tasks/{workObjectId}","/v1/tasks/{workObjectId}"},
                method=DELETE)
public void delete(@PathVariable
                                                                                                                              String workObjectId)
                                                                                                                       throws IOException

Throws:

IOException

options

@RequestMapping(value={"/tasks","/v1/tasks"},
                method=OPTIONS,
                produces="application/json")
public void options(javax.servlet.http.HttpServletResponse response)
                                                                                                                                        throws IOException

Throws:

IOException

complete

@RequestMapping(value={"/tasks/{workObjectId}/complete","/v1/tasks/{workObjectId}/complete"},
                method=PUT,
                consumes="application/json")
public void complete(@PathVariable
                                                                                                                                                                                            String workObjectId,
                                                                                                                                                                                            @RequestParam(required=false)
                                                                                                                                                                                            String view,
                                                                                                                                                                                            @RequestParam(required=false)
                                                                                                                                                                                            List<String> fields,
                                                                                                                                                                                            @RequestBody(required=false)
                                                                                                                                                                                            Map<String,String> valueMap)
                                                                                                                                                                                     throws IOException

Throws:

IOException