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

Interface OutsidePlantRestOpenApi

All Known Implementing Classes:

OutsidePlantRestController

@RequestMapping("/v2.1.1/osp-manager/")
public interface OutsidePlantRestOpenApi

Swagger documentation for outside plant manager.

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	PATH

Method Summary

Modifier and Type	Method	Description
long	createOSPView(@NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String structure, @NotNull @Valid String sessionId)
void	deleteOSPView(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
ViewObject	getOSPView(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
List<ViewObjectLight>	getOSPViews(@NotNull @Valid String sessionId)
void	updateOSPView(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String structure, @NotNull @Valid String sessionId)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

createOSPView

@RequestMapping(method=POST,
                value="createOSPView/{name}/{description}/{structure}/{sessionId}",
                produces="application/json")
long createOSPView(@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,
                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                   @NotNull @Valid String sessionId)

getOSPView

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

getOSPViews

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

updateOSPView

@RequestMapping(method=PUT,
                value="updateOSPView/{id}/{name}/{description}/{structure}/{sessionId}",
                produces="application/json")
void updateOSPView(@NotNull @Valid @PathVariable(value="id",required=true)
                   @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                   @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,
                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                   @NotNull @Valid String sessionId)

deleteOSPView

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