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

Interface FavoritesRestOpenApi

  • All Known Implementing Classes:
    FavoritesRestController
    @RequestMapping("/v2.1.1/favorites/")
public interface FavoritesRestOpenApi
    Swagger documentation for favorites.
    Author:
    Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String PATH  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addObjectTofavoritesFolder​(@NotNull @Valid String className, @NotNull @Valid String objectId, @javax.validation.constraints.NotNull,@javax.validation.Valid long folderId, @javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String sessionId)  
      long createFavoritesFolderForUser​(@NotNull @Valid String name, @javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String sessionId)  
      void deleteFavoritesFolders​(@javax.validation.constraints.NotNull,@javax.validation.Valid long[] ids, @javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String sessionId)  
      FavoritesFolder getFavoritesFolder​(@javax.validation.constraints.NotNull,@javax.validation.Valid long folderId, @javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String sessionId)  
      List<FavoritesFolder> getFavoritesFoldersForObject​(@javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String className, @NotNull @Valid String objectId, @NotNull @Valid String sessionId)  
      List<FavoritesFolder> getFavoritesFoldersForUser​(@javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String sessionId)  
      List<BusinessObjectLight> getObjectsInFavoritesFolder​(@javax.validation.constraints.NotNull,@javax.validation.Valid long folderId, @javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)  
      void removeObjectFromfavoritesFolder​(@NotNull @Valid String className, @NotNull @Valid String objectId, @javax.validation.constraints.NotNull,@javax.validation.Valid long folderId, @javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String sessionId)  
      void updateFavoritesFolder​(@javax.validation.constraints.NotNull,@javax.validation.Valid long folderId, @javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String name, @NotNull @Valid String sessionId)  

    • Method Detail

      • addObjectTofavoritesFolder

        @RequestMapping(method=PUT,
                value="addObjectTofavoritesFolder/{className}/{objectId}/{folderId}/{userId}/{sessionId}",
                produces="application/json")
void addObjectTofavoritesFolder​(@NotNull @Valid @PathVariable(value="className",required=true)
                                @NotNull @Valid String className,
                                @NotNull @Valid @PathVariable(value="objectId",required=true)
                                @NotNull @Valid String objectId,
                                @NotNull @Valid @PathVariable(value="folderId",required=true)
                                @javax.validation.constraints.NotNull,@javax.validation.Valid long folderId,
                                @NotNull @Valid @PathVariable(value="userId",required=true)
                                @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)

      • removeObjectFromfavoritesFolder

        @RequestMapping(method=DELETE,
                value="removeObjectFromfavoritesFolder/{className}/{objectId}/{folderId}/{userId}/{sessionId}",
                produces="application/json")
void removeObjectFromfavoritesFolder​(@NotNull @Valid @PathVariable(value="className",required=true)
                                     @NotNull @Valid String className,
                                     @NotNull @Valid @PathVariable(value="objectId",required=true)
                                     @NotNull @Valid String objectId,
                                     @NotNull @Valid @PathVariable(value="folderId",required=true)
                                     @javax.validation.constraints.NotNull,@javax.validation.Valid long folderId,
                                     @NotNull @Valid @PathVariable(value="userId",required=true)
                                     @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                     @NotNull @Valid String sessionId)

      • createFavoritesFolderForUser

        @RequestMapping(method=POST,
                value="createFavoritesFolderForUser/{name}/{userId}/{sessionId}",
                produces="application/json")
long createFavoritesFolderForUser​(@NotNull @Valid @PathVariable(value="name",required=true)
                                  @NotNull @Valid String name,
                                  @NotNull @Valid @PathVariable(value="userId",required=true)
                                  @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)

      • deleteFavoritesFolders

        @RequestMapping(method=DELETE,
                value="deleteFavoritesFolders/{ids}/{userId}/{sessionId}",
                produces="application/json")
void deleteFavoritesFolders​(@NotNull @Valid @PathVariable(value="ids",required=true)
                            @javax.validation.constraints.NotNull,@javax.validation.Valid long[] ids,
                            @NotNull @Valid @PathVariable(value="userId",required=true)
                            @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                            @NotNull @Valid String sessionId)

      • getFavoritesFoldersForUser

        @RequestMapping(method=GET,
                value="getFavoritesFoldersForUser/{userId}/{sessionId}",
                produces="application/json")
List<FavoritesFolder> getFavoritesFoldersForUser​(@NotNull @Valid @PathVariable(value="userId",required=true)
                                                 @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                 @NotNull @Valid String sessionId)

      • getObjectsInFavoritesFolder

        @RequestMapping(method=GET,
                value="getObjectsInFavoritesFolder/{folderId}/{userId}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getObjectsInFavoritesFolder​(@NotNull @Valid @PathVariable(value="folderId",required=true)
                                                      @javax.validation.constraints.NotNull,@javax.validation.Valid long folderId,
                                                      @NotNull @Valid @PathVariable(value="userId",required=true)
                                                      @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                                                      @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)

      • getFavoritesFoldersForObject

        @RequestMapping(method=GET,
                value="getFavoritesFoldersForObject/{userId}/{className}/{objectId}/{sessionId}",
                produces="application/json")
List<FavoritesFolder> getFavoritesFoldersForObject​(@NotNull @Valid @PathVariable(value="userId",required=true)
                                                   @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                                                   @NotNull @Valid @PathVariable(value="className",required=true)
                                                   @NotNull @Valid String className,
                                                   @NotNull @Valid @PathVariable(value="objectId",required=true)
                                                   @NotNull @Valid String objectId,
                                                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                   @NotNull @Valid String sessionId)

      • getFavoritesFolder

        @RequestMapping(method=GET,
                value="getFavoritesFolder/{folderId}/{userId}/{sessionId}",
                produces="application/json")
FavoritesFolder getFavoritesFolder​(@NotNull @Valid @PathVariable(value="folderId",required=true)
                                   @javax.validation.constraints.NotNull,@javax.validation.Valid long folderId,
                                   @NotNull @Valid @PathVariable(value="userId",required=true)
                                   @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                   @NotNull @Valid String sessionId)

      • updateFavoritesFolder

        @RequestMapping(method=PUT,
                value="updateFavoritesFolder/{folderId}/{userId}/{name}/{sessionId}",
                produces="application/json")
void updateFavoritesFolder​(@NotNull @Valid @PathVariable(value="folderId",required=true)
                           @javax.validation.constraints.NotNull,@javax.validation.Valid long folderId,
                           @NotNull @Valid @PathVariable(value="userId",required=true)
                           @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                           @NotNull @Valid @PathVariable(value="name",required=true)
                           @NotNull @Valid String name,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)