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

Interface WarehouseRestOpenApi

All Known Implementing Classes:

WarehouseRestController

@RequestMapping("/v2.1.1/warehouse-manager/")
public interface WarehouseRestOpenApi

Swagger documentation for warehouses 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
void	copyObjectToWarehouse(@NotNull @Valid String poolId, @NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean recursive, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
String	createPoolInWarehouse(@NotNull @Valid String warehouseClassName, @NotNull @Valid String warehouseId, @Valid String poolName, @Valid String poolDescription, @Valid String instancesOfClassName, @Valid String userName, @NotNull @Valid String sessionId)
String	createSparePart(@NotNull @Valid String poolId, @NotNull @Valid String className, @Valid HashMap<String,String> attributes, @Valid String templateId, @Valid String userName, @NotNull @Valid String sessionId)
String	createWarehouse(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @Valid HashMap<String,String> attributes, @Valid String templateId, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteSparePool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteWarehouse(@NotNull @Valid String warehouseClassName, @NotNull @Valid String warehouseId, @Valid String userName, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getObjectsInSparePool(@NotNull @Valid String poolId, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
List<InventoryObjectPool>	getPoolsInWarehouse(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @NotNull @Valid String sessionId)
List<InventoryObjectPool>	getWarehouseRootPools(@NotNull @Valid String sessionId)
List<BusinessObjectLight>	getWarehousesInPool(@NotNull @Valid String poolId, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
void	moveObjectToWarehouse(@NotNull @Valid String poolId, @NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @NotNull @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

createWarehouse

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

createPoolInWarehouse

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

createSparePart

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

deleteWarehouse

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

deleteSparePool

@RequestMapping(method=DELETE,
                value="deleteSparePool/{poolId}/{poolClassName}/{userName}/{sessionId}",
                produces="application/json")
void deleteSparePool(@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)

getWarehouseRootPools

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

getWarehousesInPool

@RequestMapping(method=GET,
                value="getWarehousesInPool/{poolId}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getWarehousesInPool(@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)

getPoolsInWarehouse

@RequestMapping(method=GET,
                value="getPoolsInWarehouse/{objectClassName}/{objectId}/{sessionId}",
                produces="application/json")
List<InventoryObjectPool> getPoolsInWarehouse(@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)

getObjectsInSparePool

@RequestMapping(method=GET,
                value="getObjectsInSparePool/{poolId}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getObjectsInSparePool(@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)

copyObjectToWarehouse

@RequestMapping(method=PUT,
                value="copyObjectToWarehouse/{poolId}/{objectClassName}/{objectId}/{recursive}/{userName}/{sessionId}",
                produces="application/json")
void copyObjectToWarehouse(@NotNull @Valid @PathVariable(value="poolId",required=true)
                           @NotNull @Valid String poolId,
                           @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="recursive",required=true)
                           @javax.validation.constraints.NotNull,@javax.validation.Valid boolean recursive,
                           @NotNull @Valid @PathVariable(value="userName",required=true)
                           @NotNull @Valid String userName,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)

moveObjectToWarehouse

@RequestMapping(method=PUT,
                value="moveObjectToWarehouse/{poolId}/{objectClassName}/{objectId}/{userName}/{sessionId}",
                produces="application/json")
void moveObjectToWarehouse(@NotNull @Valid @PathVariable(value="poolId",required=true)
                           @NotNull @Valid String poolId,
                           @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="userName",required=true)
                           @NotNull @Valid String userName,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)