com.edorasware.publicapi.rest

Class CaseController

java.lang.Object

com.edorasware.publicapi.rest.CaseController

@ApiController
public class CaseController
extends Object

This class implements Case specific public API methods

Constructor Summary

Constructors

Constructor and Description
CaseController(WorkObjectManager workObjectManager, com.fasterxml.jackson.databind.ObjectMapper objectMapper, CaseManager caseManager)

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)
QueryResponse	getCaseDocuments(String workObjectId, String query, Integer start, Integer size, String view, List<String> fields)
QueryResponse	getCaseItems(String workObjectId, String query, Integer start, Integer size, String view, List<String> fields)
QueryResponse	getCaseProcesses(String workObjectId, String query, Integer start, Integer size, String view, List<String> fields)
QueryResponse	getCaseTasks(String workObjectId, String query, Integer start, Integer size, String view, List<String> fields)
Map<String,Object>	getCaseWorkForm(String ambiguousWorkObjectId, Locale locale)
QueryResponse	getCurrentActions(String workObjectId)
QueryResponse	getCurrentStages(String workObjectId)
ValueMap	getInstance(String ambiguousWorkObjectId, String view, List<String> fields)
QueryResponse	getMilestones(String workObjectId)
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

CaseController

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

Method Detail

get

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

getCaseWorkForm

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

getCaseItems

@RequestMapping(value={"/cases/{workObjectId}/workobjects","/v1/cases/{workObjectId}/workobjects"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse getCaseItems(@PathVariable
                                                                                                                                                                                                                              String workObjectId,
                                                                                                                                                                                                                              @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)

getCaseTasks

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

getCaseProcesses

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

getCaseDocuments

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

create

@RequestMapping(value={"/cases","/v1/cases"},
                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={"/cases/{workObjectId}","/v1/cases/{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={"/cases/{workObjectId}","/v1/cases/{workObjectId}"},
                method=DELETE)
public void delete(@PathVariable
                                                                                                                              String workObjectId)
                                                                                                                       throws IOException

Throws:

IOException

options

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

Throws:

IOException

getCurrentStages

@RequestMapping(value={"/cases/{workObjectId}/stages","/v1/cases/{workObjectId}/stages"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse getCurrentStages(@PathVariable
                                                                                                                                                                                                                        String workObjectId)

getMilestones

@RequestMapping(value={"/cases/{workObjectId}/milestones","/v1/cases/{workObjectId}/milestones"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse getMilestones(@PathVariable
                                                                                                                                                                                                                             String workObjectId)

getCurrentActions

@RequestMapping(value={"/cases/{workObjectId}/actions","/v1/cases/{workObjectId}/actions"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse getCurrentActions(@PathVariable
                                                                                                                                                                                                                           String workObjectId)