com.edorasware.publicapi.rest

Class WorkObjectDefinitionController

java.lang.Object

com.edorasware.publicapi.rest.WorkObjectDefinitionController

@ApiController
public class WorkObjectDefinitionController
extends Object

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

Constructor Summary

Constructors

Constructor and Description
WorkObjectDefinitionController(WorkObjectDefinitionManager workObjectDefinitionManager, FormDefinitionManager formDefinitionManager)

Method Summary

Modifier and Type	Method and Description
QueryResponse	getEntityTemplatesByType(String modelId, Locale locale) Returns all the work object definitions matching the provided query.
ValueMap	getInstance(String ambiguousWorkObjectDefinitionId, String view, List<String> fields, Locale locale) Returns the work object definition matching the id.
Map<String,Object>	getWorkObjectDefinitionInitFormDefinition(String modelId, Locale locale)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkObjectDefinitionController

public WorkObjectDefinitionController(WorkObjectDefinitionManager workObjectDefinitionManager,
                                      FormDefinitionManager formDefinitionManager)

Method Detail

getEntityTemplatesByType

@RequestMapping(value={"/definitions","/v1/definitions"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse getEntityTemplatesByType(@RequestParam(required=true)
                                                                                                                                                                                                String modelId,
                                                                                                                                                                                                Locale locale)

Returns all the work object definitions matching the provided query.

Parameters:

modelId - query definitions based on a global model id

Returns:

the list of localized entity templates

getInstance

@RequestMapping(value={"/definitions/{ambiguousWorkObjectDefinitionId}","/v1/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 work object 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

getWorkObjectDefinitionInitFormDefinition

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

Throws:

Exception