Package org.neotropic.kuwaiba.northbound.rest.services

Interface ProjectRestOpenApi

All Known Implementing Classes:

ProjectRestController

@RequestMapping("/v2.1.1/planning/projects/")
public interface ProjectRestOpenApi

Swagger documentation for contract 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 module

Method Summary

Modifier and Type	Method	Description
String	copyProjectToPool(@NotNull @Valid String poolId, @NotNull @Valid String projectClassName, @NotNull @Valid String projectId, @Valid String userName, @NotNull @Valid String sessionId)
String	createActivity(@NotNull @Valid String projectId, @NotNull @Valid String projectClassName, @NotNull @Valid String activityClassName, @Valid HashMap<String,String> attributes, @Valid String userName, @NotNull @Valid String sessionId)
String	createProject(@NotNull @Valid String projectPoolId, @NotNull @Valid String projectClassName, @Valid HashMap<String,String> attributes, @Valid String userName, @NotNull @Valid String sessionId)
String	createProjectPool(@NotNull @Valid String poolName, @NotNull @Valid String poolDescription, @NotNull @Valid String poolClassName, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteActivity(@NotNull @Valid String activityClassName, @NotNull @Valid String activityId, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean releaseRelationships, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteProject(@NotNull @Valid String projectClassName, @NotNull @Valid String projectId, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteProjectPool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @Valid String userName, @NotNull @Valid String sessionId)
BusinessObject	getActivity(@NotNull @Valid String activityClassName, @NotNull @Valid String activityId, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getAllProjects(@javax.validation.constraints.NotNull,@javax.validation.Valid long page, @javax.validation.constraints.NotNull,@javax.validation.Valid long limit, @NotNull @Valid String sessionId)
BusinessObject	getProject(@NotNull @Valid String projectClassName, @NotNull @Valid String projectId, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getProjectActivities(@NotNull @Valid String projectClassName, @NotNull @Valid String projectId, @NotNull @Valid String sessionId)
InventoryObjectPool	getProjectPool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @NotNull @Valid String sessionId)
List<InventoryObjectPool>	getProjectPools(@NotNull @Valid String sessionId)
List<BusinessObjectLight>	getProjectResources(@NotNull @Valid String projectClassName, @NotNull @Valid String projectId, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getProjectsInPool(@NotNull @Valid String poolId, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getProjectsRelatedToObject(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getProjectsWithFilter(@Valid HashMap<String,String> filters, @javax.validation.constraints.NotNull,@javax.validation.Valid long page, @javax.validation.constraints.NotNull,@javax.validation.Valid long limit, @NotNull @Valid String sessionId)
void	moveProjectToPool(@NotNull @Valid String poolId, @NotNull @Valid String projectClassName, @NotNull @Valid String projectId, @Valid String userName, @NotNull @Valid String sessionId)
void	relateObjectsToProject(@NotNull @Valid String projectClassName, @NotNull @Valid String projectId, @NotNull @Valid String[] objectsClassNames, @NotNull @Valid String[] objectsIds, @Valid String userName, @NotNull @Valid String sessionId)
void	relateObjectToProject(@NotNull @Valid String projectClassName, @NotNull @Valid String projectId, @NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @Valid String userName, @NotNull @Valid String sessionId)
void	releaseObjectFromProject(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @NotNull @Valid String projectClassName, @NotNull @Valid String projectId, @Valid String userName, @NotNull @Valid String sessionId)
void	updateActivity(@NotNull @Valid String activityClassName, @NotNull @Valid String activityId, @Valid HashMap<String,String> attributes, @Valid String userName, @NotNull @Valid String sessionId)
void	updateProject(@NotNull @Valid String projectClassName, @NotNull @Valid String projectId, @Valid HashMap<String,String> attributes, @Valid String userName, @NotNull @Valid String sessionId)
void	updateProjectPool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @Valid String poolName, @Valid String poolDescription, @Valid String userName, @NotNull @Valid String sessionId)

Field Detail

PATH

static final String PATH

Path that includes the Kuwaiba version and module

See Also:

Constant Field Values

Method Detail

createProject

@RequestMapping(method=POST,
                value="createProject/{projectPoolId}/{projectClassName}/{userName}/{sessionId}",
                produces="application/json")
String createProject(@NotNull @Valid @PathVariable(value="projectPoolId",required=true)
                     @NotNull @Valid String projectPoolId,
                     @NotNull @Valid @PathVariable(value="projectClassName",required=true)
                     @NotNull @Valid String projectClassName,
                     @Valid @RequestBody
                     @Valid HashMap<String,String> attributes,
                     @Valid @PathVariable(value="userName",required=true)
                     @Valid String userName,
                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                     @NotNull @Valid String sessionId)

createProjectPool

@RequestMapping(method=POST,
                value="createProjectPool/{poolName}/{poolDescription}/{poolClassName}/{userName}/{sessionId}",
                produces="application/json")
String createProjectPool(@NotNull @Valid @PathVariable(value="poolName",required=true)
                         @NotNull @Valid String poolName,
                         @NotNull @Valid @PathVariable(value="poolDescription",required=true)
                         @NotNull @Valid String poolDescription,
                         @NotNull @Valid @PathVariable(value="poolClassName",required=true)
                         @NotNull @Valid String poolClassName,
                         @Valid @PathVariable(value="userName",required=true)
                         @Valid String userName,
                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                         @NotNull @Valid String sessionId)

createActivity

@RequestMapping(method=POST,
                value="createActivity/{projectId}/{projectClassName}/{activityClassName}/{userName}/{sessionId}",
                produces="application/json")
String createActivity(@NotNull @Valid @PathVariable(value="projectId",required=true)
                      @NotNull @Valid String projectId,
                      @NotNull @Valid @PathVariable(value="projectClassName",required=true)
                      @NotNull @Valid String projectClassName,
                      @NotNull @Valid @PathVariable(value="activityClassName",required=true)
                      @NotNull @Valid String activityClassName,
                      @Valid @RequestBody
                      @Valid HashMap<String,String> attributes,
                      @Valid @PathVariable(value="userName",required=true)
                      @Valid String userName,
                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                      @NotNull @Valid String sessionId)

updateProject

@RequestMapping(method=PUT,
                value="updateProject/{projectClassName}/{projectId}/{userName}/{sessionId}",
                produces="application/json")
void updateProject(@NotNull @Valid @PathVariable(value="projectClassName",required=true)
                   @NotNull @Valid String projectClassName,
                   @NotNull @Valid @PathVariable(value="projectId",required=true)
                   @NotNull @Valid String projectId,
                   @Valid @RequestBody
                   @Valid HashMap<String,String> attributes,
                   @Valid @PathVariable(value="userName",required=true)
                   @Valid String userName,
                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                   @NotNull @Valid String sessionId)

updateProjectPool

@RequestMapping(method=PUT,
                value="updateProjectPool/{poolId}/{poolClassName}/{poolName}/{poolDescription}/{userName}/{sessionId}",
                produces="application/json")
void updateProjectPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                       @NotNull @Valid String poolId,
                       @NotNull @Valid @PathVariable(value="poolClassName",required=true)
                       @NotNull @Valid String poolClassName,
                       @Valid @PathVariable(value="poolName",required=true)
                       @Valid String poolName,
                       @Valid @PathVariable(value="poolDescription",required=true)
                       @Valid String poolDescription,
                       @Valid @PathVariable(value="userName",required=true)
                       @Valid String userName,
                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                       @NotNull @Valid String sessionId)

updateActivity

@RequestMapping(method=PUT,
                value="updateActivity/{activityClassName}/{activityId}/{userName}/{sessionId}",
                produces="application/json")
void updateActivity(@NotNull @Valid @PathVariable(value="activityClassName",required=true)
                    @NotNull @Valid String activityClassName,
                    @NotNull @Valid @PathVariable(value="activityId",required=true)
                    @NotNull @Valid String activityId,
                    @Valid @RequestBody
                    @Valid HashMap<String,String> attributes,
                    @Valid @PathVariable(value="userName",required=true)
                    @Valid String userName,
                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                    @NotNull @Valid String sessionId)

deleteProject

@RequestMapping(method=DELETE,
                value="deleteProject/{projectClassName}/{projectId}/{userName}/{sessionId}",
                produces="application/json")
void deleteProject(@NotNull @Valid @PathVariable(value="projectClassName",required=true)
                   @NotNull @Valid String projectClassName,
                   @NotNull @Valid @PathVariable(value="projectId",required=true)
                   @NotNull @Valid String projectId,
                   @Valid @PathVariable(value="userName",required=true)
                   @Valid String userName,
                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                   @NotNull @Valid String sessionId)

deleteProjectPool

@RequestMapping(method=DELETE,
                value="deleteProjectPool/{poolId}/{poolClassName}/{userName}/{sessionId}",
                produces="application/json")
void deleteProjectPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                       @NotNull @Valid String poolId,
                       @NotNull @Valid @PathVariable(value="poolClassName",required=true)
                       @NotNull @Valid String poolClassName,
                       @Valid @PathVariable(value="userName",required=true)
                       @Valid String userName,
                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                       @NotNull @Valid String sessionId)

deleteActivity

@RequestMapping(method=DELETE,
                value="deleteActivity/{activityClassName}/{activityId}/{releaseRelationships}/{userName}/{sessionId}",
                produces="application/json")
void deleteActivity(@NotNull @Valid @PathVariable(value="activityClassName",required=true)
                    @NotNull @Valid String activityClassName,
                    @NotNull @Valid @PathVariable(value="activityId",required=true)
                    @NotNull @Valid String activityId,
                    @NotNull @Valid @PathVariable(value="releaseRelationships",required=true)
                    @javax.validation.constraints.NotNull,@javax.validation.Valid boolean releaseRelationships,
                    @Valid @PathVariable(value="userName",required=true)
                    @Valid String userName,
                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                    @NotNull @Valid String sessionId)

getAllProjects

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

getProjectsInPool

@RequestMapping(method=GET,
                value="getProjectsInPool/{poolId}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getProjectsInPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                            @NotNull @Valid String poolId,
                                            @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)

getProjectsRelatedToObject

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

getProjectResources

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

getProjectActivities

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

getProjectsWithFilter

@RequestMapping(method=POST,
                value="getProjectsWithFilter/{page}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getProjectsWithFilter(@Valid @RequestBody
                                                @Valid HashMap<String,String> filters,
                                                @NotNull @Valid @PathVariable(value="page",required=true)
                                                @javax.validation.constraints.NotNull,@javax.validation.Valid long page,
                                                @NotNull @Valid @PathVariable(value="limit",required=true)
                                                @javax.validation.constraints.NotNull,@javax.validation.Valid long limit,
                                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                @NotNull @Valid String sessionId)

getProjectPools

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

getProjectPool

@RequestMapping(method=GET,
                value="getProjectPool/{poolId}/{poolClassName}/{sessionId}",
                produces="application/json")
InventoryObjectPool getProjectPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                   @NotNull @Valid String poolId,
                                   @NotNull @Valid @PathVariable(value="poolClassName",required=true)
                                   @NotNull @Valid String poolClassName,
                                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                   @NotNull @Valid String sessionId)

getProject

@RequestMapping(method=GET,
                value="getProject/{projectClassName}/{projectId}/{sessionId}",
                produces="application/json")
BusinessObject getProject(@NotNull @Valid @PathVariable(value="projectClassName",required=true)
                          @NotNull @Valid String projectClassName,
                          @NotNull @Valid @PathVariable(value="projectId",required=true)
                          @NotNull @Valid String projectId,
                          @NotNull @Valid @PathVariable(value="sessionId",required=true)
                          @NotNull @Valid String sessionId)

getActivity

@RequestMapping(method=GET,
                value="getActivity/{activityClassName}/{activityId}/{sessionId}",
                produces="application/json")
BusinessObject getActivity(@NotNull @Valid @PathVariable(value="activityClassName",required=true)
                           @NotNull @Valid String activityClassName,
                           @NotNull @Valid @PathVariable(value="activityId",required=true)
                           @NotNull @Valid String activityId,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)

copyProjectToPool

@RequestMapping(method=PUT,
                value="copyProjectToPool/{poolId}/{projectClassName}/{projectId}/{userName}/{sessionId}",
                produces="application/json")
String copyProjectToPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                         @NotNull @Valid String poolId,
                         @NotNull @Valid @PathVariable(value="projectClassName",required=true)
                         @NotNull @Valid String projectClassName,
                         @NotNull @Valid @PathVariable(value="projectId",required=true)
                         @NotNull @Valid String projectId,
                         @Valid @PathVariable(value="userName",required=true)
                         @Valid String userName,
                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                         @NotNull @Valid String sessionId)

moveProjectToPool

@RequestMapping(method=PUT,
                value="moveProjectToPool/{poolId}/{projectClassName}/{projectId}/{userName}/{sessionId}",
                produces="application/json")
void moveProjectToPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                       @NotNull @Valid String poolId,
                       @NotNull @Valid @PathVariable(value="projectClassName",required=true)
                       @NotNull @Valid String projectClassName,
                       @NotNull @Valid @PathVariable(value="projectId",required=true)
                       @NotNull @Valid String projectId,
                       @Valid @PathVariable(value="userName",required=true)
                       @Valid String userName,
                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                       @NotNull @Valid String sessionId)

relateObjectsToProject

@RequestMapping(method=PUT,
                value="relateObjectsToProject/{projectClassName}/{projectId}/{objectsClassNames}/{objectsIds}/{userName}/{sessionId}",
                produces="application/json")
void relateObjectsToProject(@NotNull @Valid @PathVariable(value="projectClassName",required=true)
                            @NotNull @Valid String projectClassName,
                            @NotNull @Valid @PathVariable(value="projectId",required=true)
                            @NotNull @Valid String projectId,
                            @NotNull @Valid @PathVariable(value="objectsClassNames",required=true)
                            @NotNull @Valid String[] objectsClassNames,
                            @NotNull @Valid @PathVariable(value="objectsIds",required=true)
                            @NotNull @Valid String[] objectsIds,
                            @Valid @PathVariable(value="userName",required=true)
                            @Valid String userName,
                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                            @NotNull @Valid String sessionId)

relateObjectToProject

@RequestMapping(method=PUT,
                value="relateObjectToProject/{projectClassName}/{projectId}/{objectClassName}/{objectId}/{userName}/{sessionId}",
                produces="application/json")
void relateObjectToProject(@NotNull @Valid @PathVariable(value="projectClassName",required=true)
                           @NotNull @Valid String projectClassName,
                           @NotNull @Valid @PathVariable(value="projectId",required=true)
                           @NotNull @Valid String projectId,
                           @NotNull @Valid @PathVariable(value="objectClassName",required=true)
                           @NotNull @Valid String objectClassName,
                           @NotNull @Valid @PathVariable(value="objectId",required=true)
                           @NotNull @Valid String objectId,
                           @Valid @PathVariable(value="userName",required=true)
                           @Valid String userName,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)

releaseObjectFromProject

@RequestMapping(method=PUT,
                value="releaseObjectFromProject/{objectClassName}/{objectId}/{projectClassName}/{projectId}/{userName}/{sessionId}",
                produces="application/json")
void releaseObjectFromProject(@NotNull @Valid @PathVariable(value="objectClassName",required=true)
                              @NotNull @Valid String objectClassName,
                              @NotNull @Valid @PathVariable(value="objectId",required=true)
                              @NotNull @Valid String objectId,
                              @NotNull @Valid @PathVariable(value="projectClassName",required=true)
                              @NotNull @Valid String projectClassName,
                              @NotNull @Valid @PathVariable(value="projectId",required=true)
                              @NotNull @Valid String projectId,
                              @Valid @PathVariable(value="userName",required=true)
                              @Valid String userName,
                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                              @NotNull @Valid String sessionId)