Package org.neotropic.kuwaiba.northbound.rest.aem

Interface TemplateRestOpenApi

All Known Implementing Classes:

TemplateRestController

public interface TemplateRestOpenApi

Swagger documentation for template manager.

Author:

Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>

Field Summary

Fields

Modifier and Type	Field	Description
static String	PATH	Path that includes the Kuwaiba version and the module id

Method Summary

Modifier and Type	Method	Description
String[]	copyTemplateElements(@NotNull @Valid String[] sourceObjectsClassNames, @NotNull @Valid String[] sourceObjectsIds, @NotNull @Valid String newParentClassName, @NotNull @Valid String newParentId, @NotNull @Valid String sessionId)
String[]	copyTemplateSpecialElement(@NotNull @Valid String[] sourceObjectsClassNames, @NotNull @Valid String[] sourceObjectsIds, @NotNull @Valid String newParentClassName, @NotNull @Valid String newParentId, @NotNull @Valid String sessionId)
String[]	createBulkSpecialTemplateElement(@NotNull @Valid String className, @NotNull @Valid String parentClassName, @NotNull @Valid String parentId, @Valid String namePattern, @NotNull @Valid String sessionId)
String[]	createBulkTemplateElement(@NotNull @Valid String className, @NotNull @Valid String parentClassName, @NotNull @Valid String parentId, @Valid String namePattern, @NotNull @Valid String sessionId)
String	createTemplate(@NotNull @Valid String className, @NotNull @Valid String name, @NotNull @Valid String sessionId)
String	createTemplateElement(@NotNull @Valid String className, @NotNull @Valid String parentClassName, @NotNull @Valid String parentId, @NotNull @Valid String name, @NotNull @Valid String sessionId)
String	createTemplateSpecialElement(@NotNull @Valid String className, @NotNull @Valid String parentClassName, @NotNull @Valid String parentId, @NotNull @Valid String name, @NotNull @Valid String sessionId)
ChangeDescriptor	deleteTemplateElement(@NotNull @Valid String className, @NotNull @Valid String id, @NotNull @Valid String sessionId)
TemplateObject	getTemplateElement(@NotNull @Valid String className, @NotNull @Valid String id, @NotNull @Valid String sessionId)
List<TemplateObjectLight>	getTemplateElementChildren(@NotNull @Valid String className, @NotNull @Valid String id, @NotNull @Valid String sessionId)
List<TemplateObjectLight>	getTemplatesForClass(@NotNull @Valid String className, @NotNull @Valid String sessionId)
List<TemplateObjectLight>	getTemplateSpecialElementChildren(@NotNull @Valid String className, @NotNull @Valid String id, @NotNull @Valid String sessionId)
ChangeDescriptor	updateTemplateElement(@NotNull @Valid String className, @NotNull @Valid String id, @NotNull @Valid String[] attributeNames, @NotNull @Valid String[] attributeValues, @NotNull @Valid String sessionId)

Field Detail

PATH

static final String PATH

Path that includes the Kuwaiba version and the module id

See Also:

Constant Field Values

Method Detail

createTemplate

@RequestMapping(method=POST,
                value="createTemplate/{className}/{name}/{sessionId}",
                produces="application/json")
String createTemplate(@NotNull @Valid @PathVariable(value="className",required=true)
                      @NotNull @Valid String className,
                      @NotNull @Valid @PathVariable(value="name",required=true)
                      @NotNull @Valid String name,
                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                      @NotNull @Valid String sessionId)

createTemplateElement

@RequestMapping(method=POST,
                value="createTemplateSpecialElement/{className}/{parentClassName}/{parentId}/{name}/{sessionId}",
                produces="application/json")
String createTemplateElement(@NotNull @Valid @PathVariable(value="className",required=true)
                             @NotNull @Valid String className,
                             @NotNull @Valid @PathVariable(value="parentClassName",required=true)
                             @NotNull @Valid String parentClassName,
                             @NotNull @Valid @PathVariable(value="parentId",required=true)
                             @NotNull @Valid String parentId,
                             @NotNull @Valid @PathVariable(value="name",required=true)
                             @NotNull @Valid String name,
                             @NotNull @Valid @PathVariable(value="sessionId",required=true)
                             @NotNull @Valid String sessionId)

createTemplateSpecialElement

@RequestMapping(method=POST,
                value="createTemplateSpecialElement/{className}/{parentClassName}/{parentId}/{name}/{sessionId}",
                produces="application/json")
String createTemplateSpecialElement(@NotNull @Valid @PathVariable(value="className",required=true)
                                    @NotNull @Valid String className,
                                    @NotNull @Valid @PathVariable(value="parentClassName",required=true)
                                    @NotNull @Valid String parentClassName,
                                    @NotNull @Valid @PathVariable(value="parentId",required=true)
                                    @NotNull @Valid String parentId,
                                    @NotNull @Valid @PathVariable(value="name",required=true)
                                    @NotNull @Valid String name,
                                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                    @NotNull @Valid String sessionId)

createBulkTemplateElement

@RequestMapping(method=POST,
                value="createBulkTemplateElement/{className}/{parentClassName}/{parentId}/{sessionId}",
                produces="application/json")
String[] createBulkTemplateElement(@NotNull @Valid @PathVariable(value="className",required=true)
                                   @NotNull @Valid String className,
                                   @NotNull @Valid @PathVariable(value="parentClassName",required=true)
                                   @NotNull @Valid String parentClassName,
                                   @NotNull @Valid @PathVariable(value="parentId",required=true)
                                   @NotNull @Valid String parentId,
                                   @Valid @RequestBody
                                   @Valid String namePattern,
                                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                   @NotNull @Valid String sessionId)

createBulkSpecialTemplateElement

@RequestMapping(method=POST,
                value="createBulkSpecialTemplateElement/{className}/{parentClassName}/{parentId}/{sessionId}",
                produces="application/json")
String[] createBulkSpecialTemplateElement(@NotNull @Valid @PathVariable(value="className",required=true)
                                          @NotNull @Valid String className,
                                          @NotNull @Valid @PathVariable(value="parentClassName",required=true)
                                          @NotNull @Valid String parentClassName,
                                          @NotNull @Valid @PathVariable(value="parentId",required=true)
                                          @NotNull @Valid String parentId,
                                          @Valid @RequestBody
                                          @Valid String namePattern,
                                          @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                          @NotNull @Valid String sessionId)

updateTemplateElement

@RequestMapping(method=PUT,
                value="updateTemplateElement/{className}/{id}/{attributeNames}/{attributeValues}/{sessionId}",
                produces="application/json")
ChangeDescriptor updateTemplateElement(@NotNull @Valid @PathVariable(value="className",required=true)
                                       @NotNull @Valid String className,
                                       @NotNull @Valid @PathVariable(value="id",required=true)
                                       @NotNull @Valid String id,
                                       @NotNull @Valid @PathVariable(value="attributeNames",required=true)
                                       @NotNull @Valid String[] attributeNames,
                                       @NotNull @Valid @PathVariable(value="attributeValues",required=true)
                                       @NotNull @Valid String[] attributeValues,
                                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                       @NotNull @Valid String sessionId)

deleteTemplateElement

@RequestMapping(method=DELETE,
                value="deleteTemplateElement/{className}/{id}/{sessionId}",
                produces="application/json")
ChangeDescriptor deleteTemplateElement(@NotNull @Valid @PathVariable(value="className",required=true)
                                       @NotNull @Valid String className,
                                       @NotNull @Valid @PathVariable(value="id",required=true)
                                       @NotNull @Valid String id,
                                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                       @NotNull @Valid String sessionId)

getTemplatesForClass

@RequestMapping(method=GET,
                value="getTemplatesForClass/{className}/{sessionId}",
                produces="application/json")
List<TemplateObjectLight> getTemplatesForClass(@NotNull @Valid @PathVariable(value="className",required=true)
                                               @NotNull @Valid String className,
                                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                               @NotNull @Valid String sessionId)

getTemplateElementChildren

@RequestMapping(method=GET,
                value="getTemplateElementChildren/{className}/{id}/{sessionId}",
                produces="application/json")
List<TemplateObjectLight> getTemplateElementChildren(@NotNull @Valid @PathVariable(value="className",required=true)
                                                     @NotNull @Valid String className,
                                                     @NotNull @Valid @PathVariable(value="id",required=true)
                                                     @NotNull @Valid String id,
                                                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                     @NotNull @Valid String sessionId)

getTemplateSpecialElementChildren

@RequestMapping(method=GET,
                value="getTemplateSpecialElementChildren/{className}/{id}/{sessionId}",
                produces="application/json")
List<TemplateObjectLight> getTemplateSpecialElementChildren(@NotNull @Valid @PathVariable(value="className",required=true)
                                                            @NotNull @Valid String className,
                                                            @NotNull @Valid @PathVariable(value="id",required=true)
                                                            @NotNull @Valid String id,
                                                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                            @NotNull @Valid String sessionId)

getTemplateElement

@RequestMapping(method=GET,
                value="getTemplateElement/{className}/{id}/{sessionId}",
                produces="application/json")
TemplateObject getTemplateElement(@NotNull @Valid @PathVariable(value="className",required=true)
                                  @NotNull @Valid String className,
                                  @NotNull @Valid @PathVariable(value="id",required=true)
                                  @NotNull @Valid String id,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)

copyTemplateElements

@RequestMapping(method=PUT,
                value="copyTemplateElements/{sourceObjectsClassNames}/{sourceObjectsIds}/{newParentClassName}/{newParentId}/{sessionId}",
                produces="application/json")
String[] copyTemplateElements(@NotNull @Valid @PathVariable(value="sourceObjectsClassNames",required=true)
                              @NotNull @Valid String[] sourceObjectsClassNames,
                              @NotNull @Valid @PathVariable(value="sourceObjectsIds",required=true)
                              @NotNull @Valid String[] sourceObjectsIds,
                              @NotNull @Valid @PathVariable(value="newParentClassName",required=true)
                              @NotNull @Valid String newParentClassName,
                              @NotNull @Valid @PathVariable(value="newParentId",required=true)
                              @NotNull @Valid String newParentId,
                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                              @NotNull @Valid String sessionId)

copyTemplateSpecialElement

@RequestMapping(method=PUT,
                value="copyTemplateSpecialElement/{sourceObjectsClassNames}/{sourceObjectsIds}/{newParentClassName}/{newParentId}/{sessionId}",
                produces="application/json")
String[] copyTemplateSpecialElement(@NotNull @Valid @PathVariable(value="sourceObjectsClassNames",required=true)
                                    @NotNull @Valid String[] sourceObjectsClassNames,
                                    @NotNull @Valid @PathVariable(value="sourceObjectsIds",required=true)
                                    @NotNull @Valid String[] sourceObjectsIds,
                                    @NotNull @Valid @PathVariable(value="newParentClassName",required=true)
                                    @NotNull @Valid String newParentClassName,
                                    @NotNull @Valid @PathVariable(value="newParentId",required=true)
                                    @NotNull @Valid String newParentId,
                                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                    @NotNull @Valid String sessionId)