com.edorasware.publicapi.rest

Class CaseDefinitionController

java.lang.Object

com.edorasware.publicapi.rest.CaseDefinitionController

@ApiController
public class CaseDefinitionController
extends Object

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

Constructor Summary

Constructors

Constructor and Description
CaseDefinitionController(WorkObjectDefinitionManager workObjectDefinitionManager, FormDefinitionManager formDefinitionManager)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getCaseInitFormDefinition(String modelId, Locale locale)
QueryResponse	getEntityTemplatesByType(String nameFilter, String modelId, Integer start, Integer size, Locale locale) Returns all the case definitions matching the provided query.
ValueMap	getInstance(String ambiguousWorkObjectDefinitionId, String view, List<String> fields, Locale locale) Returns the case definition matching the id.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaseDefinitionController

public CaseDefinitionController(WorkObjectDefinitionManager workObjectDefinitionManager,
                                FormDefinitionManager formDefinitionManager)

Method Detail

getEntityTemplatesByType

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

Returns all the case definitions matching the provided query.

Parameters:

nameFilter - query to search for the typed text

modelId - query definitions based on a global model id

Returns:

the list of localized entity templates

getInstance

@RequestMapping(value={"/case-definitions/{ambiguousWorkObjectDefinitionId}","/v1/case-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 case definition matching the id.

Parameters:

ambiguousWorkObjectDefinitionId - get case definition based on the work object definition id or global model id

Returns:

work object definition value map

getCaseInitFormDefinition

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

Throws:

Exception