com.edorasware.publicapi.rest

Class ProcessController

java.lang.Object

com.edorasware.publicapi.rest.ProcessController

@ApiController
public class ProcessController
extends Object

This class implements Process specific public API methods

Constructor Summary

Constructors

Constructor and Description
ProcessController(WorkObjectManager workObjectManager, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
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	getProcessDocuments(String workObjectId, String query, Integer start, Integer size, String view, List<String> fields)
QueryResponse	getProcessItems(String workObjectId, String query, Integer start, Integer size, String view, List<String> fields)
QueryResponse	getProcessTasks(String workObjectId, String query, Integer start, Integer size, String view, List<String> fields)
Map<String,Object>	getProcessWorkForm(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

ProcessController

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

Method Detail

get

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

getProcessWorkForm

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

getProcessItems

@RequestMapping(value={"/processes/{workObjectId}/workobjects","/v1/processes/{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)

getProcessTasks

@RequestMapping(value={"/processes/{workObjectId}/tasks","/v1/processes/{workObjectId}/tasks"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse getProcessTasks(@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)

getProcessDocuments

@RequestMapping(value={"/processes/{workObjectId}/documents","/v1/processes/{workObjectId}/documents"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse getProcessDocuments(@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={"/processes","/v1/processes"},
                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={"/processes/{workObjectId}","/v1/processes/{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

delete

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

Throws:

IOException

options

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

Throws:

IOException