com.edorasware.publicapi.rest

Class DocumentDefinitionController

java.lang.Object

com.edorasware.publicapi.rest.DocumentDefinitionController

@ApiController
public class DocumentDefinitionController
extends Object

This class implements Document definition specific public API methods

Constructor Summary

Constructors

Constructor and Description
DocumentDefinitionController(WorkObjectDefinitionManager workObjectDefinitionManager, FormDefinitionManager formDefinitionManager)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentDefinitionController

@Autowired
public DocumentDefinitionController(WorkObjectDefinitionManager workObjectDefinitionManager,
                                               FormDefinitionManager formDefinitionManager)

Method Detail

getEntityTemplatesByType

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

Parameters:

ambiguousWorkObjectDefinitionId - query definitions based on a global model id

Returns:

work object definition value map

getDocumentInitFormDefinition

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

Throws:

Exception