com.edorasware.publicapi.rest

Class ProcessDefinitionController

java.lang.Object

com.edorasware.publicapi.rest.ProcessDefinitionController

@ApiController
public class ProcessDefinitionController
extends Object

Provides public REST API for com.edorasware.commons.core.entity.WorkObjectDefinition manipulation

Constructor Summary

Constructors

Constructor and Description
ProcessDefinitionController(WorkObjectDefinitionManager workObjectDefinitionManager, FormDefinitionManager formDefinitionManager)

Method Summary

Modifier and Type	Method and Description
QueryResponse	getEntityTemplatesByType(String nameFilter, String modelId, String caseId, Integer start, Integer size, Locale locale) Returns all the process definitions matching the provided name filter or model global id.
ValueMap	getInstance(String ambiguousWorkObjectDefinitionId, String view, List<String> fields, Locale locale) Returns the process definition matching the id.
Map<String,Object>	getProcessInitFormDefinition(String modelId, Locale locale)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessDefinitionController

public ProcessDefinitionController(WorkObjectDefinitionManager workObjectDefinitionManager,
                                   FormDefinitionManager formDefinitionManager)

Method Detail

getEntityTemplatesByType

@RequestMapping(value={"/process-definitions","/v1/process-definitions"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse getEntityTemplatesByType(@RequestParam(required=false,defaultValue="")
                                                                                                                                                                                                                String nameFilter,
                                                                                                                                                                                                                @RequestParam(required=false)
                                                                                                                                                                                                                String modelId,
                                                                                                                                                                                                                @RequestParam(required=false)
                                                                                                                                                                                                                String caseId,
                                                                                                                                                                                                                @RequestParam(required=false)
                                                                                                                                                                                                                Integer start,
                                                                                                                                                                                                                @RequestParam(required=false,defaultValue="50")
                                                                                                                                                                                                                Integer size,
                                                                                                                                                                                                                Locale locale)

Returns all the process definitions matching the provided name filter or model global id.

Parameters:

nameFilter - query to search for the typed text

modelId - query definitions based on a global model id

caseId - query definitions based on the restrictions of a case id or case global id

Returns:

the list of localized entity templates

getInstance

@RequestMapping(value={"/process-definitions/{ambiguousWorkObjectDefinitionId}","/v1/process-definitions/{ambiguousWorkObjectDefinitionId}"},
                method=GET,
                produces="application/json")
 @ResponseBody
public ValueMap getInstance(@PathVariable
                                                                                                                                                                                                                                                                  String ambiguousWorkObjectDefinitionId,
                                                                                                                                                                                                                                                                  @RequestParam(required=false)
                                                                                                                                                                                                                                                                  String view,
                                                                                                                                                                                                                                                                  @RequestParam(required=false)
                                                                                                                                                                                                                                                                  List<String> fields,
                                                                                                                                                                                                                                                                  Locale locale)

Returns the process definition matching the id.

Parameters:

ambiguousWorkObjectDefinitionId - query definitions based on a work object definition id or global model id

Returns:

work object definition value map

getProcessInitFormDefinition

@ResponseBody
 @RequestMapping(value={"/process-definitions/{modelId}/init-form","/v1/process-definitions/{modelId}/init-form"},
                method=GET,
                produces="application/json")
public Map<String,Object> getProcessInitFormDefinition(@PathVariable
                                                                                                                                                                                                                                                                 String modelId,
                                                                                                                                                                                                                                                                 Locale locale)
                                                                                                                                                                                                                                                          throws Exception

Throws:

Exception