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

Interface LayoutRestOpenApi

All Known Implementing Classes:

LayoutRestController

@RequestMapping("/v2.1.1/layout-editor/")
public interface LayoutRestOpenApi

Swagger documentation for layout editor.

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
long	createLayout(@Valid String viewClassName, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String structure, @Valid String background, @NotNull @Valid String sessionId)
long	createListTypeItemRelatedLayout(@NotNull @Valid String listTypeItemId, @NotNull @Valid String listTypeItemClassName, @NotNull @Valid String viewClassName, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String structure, @Valid String background, @NotNull @Valid String sessionId)
void	deleteLayout(@javax.validation.constraints.NotNull,@javax.validation.Valid long viewId, @NotNull @Valid String sessionId)
void	deleteListTypeItemRelatedLayout(@NotNull @Valid String listTypeItemId, @NotNull @Valid String listTypeItemClassName, @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getDeviceLayouts(@NotNull @Valid String sessionId)
byte[]	getDeviceLayoutStructure(@NotNull @Valid String id, @NotNull @Valid String className, @NotNull @Valid String sessionId)
ViewObject	getLayout(@javax.validation.constraints.NotNull,@javax.validation.Valid long viewId, @NotNull @Valid String sessionId)
List<ViewObjectLight>	getLayouts(@javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
BusinessObjectLight	getListTypeItemForLayout(@javax.validation.constraints.NotNull,@javax.validation.Valid long viewId, @NotNull @Valid String sessionId)
ViewObject	getListTypeItemRelatedLayout(@NotNull @Valid String listTypeItemId, @NotNull @Valid String listTypeItemClassName, @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId, @NotNull @Valid String sessionId)
List<ViewObjectLight>	getListTypeItemRelatedLayouts(@NotNull @Valid String listTypeItemId, @NotNull @Valid String listTypeItemClassName, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
void	releaseListTypeItemRelatedLayout(@NotNull @Valid String listTypeItemId, @NotNull @Valid String listTypeItemClassName, @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId, @NotNull @Valid String sessionId)
void	setListTypeItemRelatedLayout(@NotNull @Valid String listTypeItemId, @NotNull @Valid String listTypeItemClassName, @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId, @NotNull @Valid String sessionId)
ChangeDescriptor	updateLayout(@javax.validation.constraints.NotNull,@javax.validation.Valid long viewId, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String structure, @Valid String background, @NotNull @Valid String sessionId)
ChangeDescriptor	updateListTypeItemRelatedLayout(@NotNull @Valid String listTypeItemId, @NotNull @Valid String listTypeItemClassName, @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String structure, @Valid String background, @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

createListTypeItemRelatedLayout

@RequestMapping(method=POST,
                value="createListTypeItemRelatedLayout/{listTypeItemId}/{listTypeItemClassName}/{viewClassName}/{name}/{description}/{structure}/{background}/{sessionId}",
                produces="application/json")
long createListTypeItemRelatedLayout(@NotNull @Valid @PathVariable(value="listTypeItemId",required=true)
                                     @NotNull @Valid String listTypeItemId,
                                     @NotNull @Valid @PathVariable(value="listTypeItemClassName",required=true)
                                     @NotNull @Valid String listTypeItemClassName,
                                     @NotNull @Valid @PathVariable(value="viewClassName",required=true)
                                     @NotNull @Valid String viewClassName,
                                     @NotNull @Valid @PathVariable(value="name",required=true)
                                     @NotNull @Valid String name,
                                     @NotNull @Valid @PathVariable(value="description",required=true)
                                     @NotNull @Valid String description,
                                     @NotNull @Valid @PathVariable(value="structure",required=true)
                                     @NotNull @Valid String structure,
                                     @Valid @PathVariable(value="background",required=true)
                                     @Valid String background,
                                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                     @NotNull @Valid String sessionId)

getLayouts

@RequestMapping(method=GET,
                value="getLayouts/{limit}/{sessionId}",
                produces="application/json")
List<ViewObjectLight> getLayouts(@NotNull @Valid @PathVariable(value="limit",required=true)
                                 @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                 @NotNull @Valid String sessionId)

getLayout

@RequestMapping(method=GET,
                value="getLayout/{viewId}/{sessionId}",
                produces="application/json")
ViewObject getLayout(@NotNull @Valid @PathVariable(value="viewId",required=true)
                     @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                     @NotNull @Valid String sessionId)

getListTypeItemForLayout

@RequestMapping(method=GET,
                value="getListTypeItemForLayout/{viewId}/{sessionId}",
                produces="application/json")
BusinessObjectLight getListTypeItemForLayout(@NotNull @Valid @PathVariable(value="viewId",required=true)
                                             @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                                             @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                             @NotNull @Valid String sessionId)

createLayout

@RequestMapping(method=POST,
                value="createLayout/{viewClassName}/{name}/{description}/{structure}/{background}/{sessionId}",
                produces="application/json")
long createLayout(@Valid @PathVariable(value="viewClassName",required=true)
                  @Valid String viewClassName,
                  @NotNull @Valid @PathVariable(value="name",required=true)
                  @NotNull @Valid String name,
                  @NotNull @Valid @PathVariable(value="description",required=true)
                  @NotNull @Valid String description,
                  @NotNull @Valid @PathVariable(value="structure",required=true)
                  @NotNull @Valid String structure,
                  @Valid @PathVariable(value="background",required=true)
                  @Valid String background,
                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                  @NotNull @Valid String sessionId)

setListTypeItemRelatedLayout

@RequestMapping(method=PUT,
                value="setListTypeItemRelatedLayout/{listTypeItemId}/{listTypeItemClassName}/{viewId}/{sessionId}",
                produces="application/json")
void setListTypeItemRelatedLayout(@NotNull @Valid @PathVariable(value="listTypeItemId",required=true)
                                  @NotNull @Valid String listTypeItemId,
                                  @NotNull @Valid @PathVariable(value="listTypeItemClassName",required=true)
                                  @NotNull @Valid String listTypeItemClassName,
                                  @NotNull @Valid @PathVariable(value="viewId",required=true)
                                  @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)

releaseListTypeItemRelatedLayout

@RequestMapping(method=PUT,
                value="releaseListTypeItemRelatedLayout/{listTypeItemId}/{listTypeItemClassName}/{viewId}/{sessionId}",
                produces="application/json")
void releaseListTypeItemRelatedLayout(@NotNull @Valid @PathVariable(value="listTypeItemId",required=true)
                                      @NotNull @Valid String listTypeItemId,
                                      @NotNull @Valid @PathVariable(value="listTypeItemClassName",required=true)
                                      @NotNull @Valid String listTypeItemClassName,
                                      @NotNull @Valid @PathVariable(value="viewId",required=true)
                                      @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                      @NotNull @Valid String sessionId)

getListTypeItemRelatedLayout

@RequestMapping(method=GET,
                value="getListTypeItemRelatedLayout/{listTypeItemId}/{listTypeItemClassName}/{viewId}/{sessionId}",
                produces="application/json")
ViewObject getListTypeItemRelatedLayout(@NotNull @Valid @PathVariable(value="listTypeItemId",required=true)
                                        @NotNull @Valid String listTypeItemId,
                                        @NotNull @Valid @PathVariable(value="listTypeItemClassName",required=true)
                                        @NotNull @Valid String listTypeItemClassName,
                                        @NotNull @Valid @PathVariable(value="viewId",required=true)
                                        @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                        @NotNull @Valid String sessionId)

updateListTypeItemRelatedLayout

@RequestMapping(method=PUT,
                value="updateListTypeItemRelatedLayout/{listTypeItemId}/{listTypeItemClassName}/{viewId}/{name}/{description}/{structure}/{background}/{sessionId}",
                produces="application/json")
ChangeDescriptor updateListTypeItemRelatedLayout(@NotNull @Valid @PathVariable(value="listTypeItemId",required=true)
                                                 @NotNull @Valid String listTypeItemId,
                                                 @NotNull @Valid @PathVariable(value="listTypeItemClassName",required=true)
                                                 @NotNull @Valid String listTypeItemClassName,
                                                 @NotNull @Valid @PathVariable(value="viewId",required=true)
                                                 @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                                                 @NotNull @Valid @PathVariable(value="name",required=true)
                                                 @NotNull @Valid String name,
                                                 @NotNull @Valid @PathVariable(value="description",required=true)
                                                 @NotNull @Valid String description,
                                                 @NotNull @Valid @PathVariable(value="structure",required=true)
                                                 @NotNull @Valid String structure,
                                                 @Valid @PathVariable(value="background",required=true)
                                                 @Valid String background,
                                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                 @NotNull @Valid String sessionId)

updateLayout

@RequestMapping(method=PUT,
                value="updateLayout/{viewId}/{name}/{description}/{structure}/{background}/{sessionId}",
                produces="application/json")
ChangeDescriptor updateLayout(@NotNull @Valid @PathVariable(value="viewId",required=true)
                              @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                              @NotNull @Valid @PathVariable(value="name",required=true)
                              @NotNull @Valid String name,
                              @NotNull @Valid @PathVariable(value="description",required=true)
                              @NotNull @Valid String description,
                              @NotNull @Valid @PathVariable(value="structure",required=true)
                              @NotNull @Valid String structure,
                              @Valid @PathVariable(value="background",required=true)
                              @Valid String background,
                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                              @NotNull @Valid String sessionId)

getListTypeItemRelatedLayouts

@RequestMapping(method=GET,
                value="getListTypeItemRelatedLayouts/{listTypeItemId}/{listTypeItemClassName}/{limit}/{sessionId}",
                produces="application/json")
List<ViewObjectLight> getListTypeItemRelatedLayouts(@NotNull @Valid @PathVariable(value="listTypeItemId",required=true)
                                                    @NotNull @Valid String listTypeItemId,
                                                    @NotNull @Valid @PathVariable(value="listTypeItemClassName",required=true)
                                                    @NotNull @Valid String listTypeItemClassName,
                                                    @NotNull @Valid @PathVariable(value="limit",required=true)
                                                    @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                    @NotNull @Valid String sessionId)

deleteListTypeItemRelatedLayout

@RequestMapping(method=DELETE,
                value="deleteListTypeItemRelatedLayout/{listTypeItemId}/{listTypeItemClassName}/{viewId}/{sessionId}",
                produces="application/json")
void deleteListTypeItemRelatedLayout(@NotNull @Valid @PathVariable(value="listTypeItemId",required=true)
                                     @NotNull @Valid String listTypeItemId,
                                     @NotNull @Valid @PathVariable(value="listTypeItemClassName",required=true)
                                     @NotNull @Valid String listTypeItemClassName,
                                     @NotNull @Valid @PathVariable(value="viewId",required=true)
                                     @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                     @NotNull @Valid String sessionId)

deleteLayout

@RequestMapping(method=DELETE,
                value="deleteLayout/{viewId}/{sessionId}",
                produces="application/json")
void deleteLayout(@NotNull @Valid @PathVariable(value="viewId",required=true)
                  @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                  @NotNull @Valid String sessionId)

getDeviceLayouts

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

getDeviceLayoutStructure

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