Class PortfolioApiController

java.lang.Object

com.bluebell.greenhouse.planter.controllers.portfolio.PortfolioApiController

@RestController
@RequestMapping("${bluebell.base.api.controller.endpoint}/portfolio")
@CrossOrigin(origins="*",
             methods={GET,DELETE,POST,PUT})
public class PortfolioApiController
extends Object

API controller for Portfolio.

Version:

3.0.6

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
PortfolioApiController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	deletePortfolio(PortfolioRequestContext context)	Deletes an Portfolio with the matching number.
org.springframework.http.ResponseEntity<PortfolioDTO>	getPortfolioForPortfolioNumber(PortfolioRequestContext context)	Returns a ResponseEntity containing a PortfolioDTO.
org.springframework.http.ResponseEntity<org.springframework.core.io.ByteArrayResource>	getPortfolioReport(PortfolioRequestContext context)	Generates a zip archive containing account reports for all accounts in the given portfolio.
org.springframework.http.ResponseEntity<PortfolioDTO>	postCreateNewPortfolio(@Valid CreateUpdatePortfolioDTO data, AuthenticatedUserRef userRef)	Returns a Portfolio.
org.springframework.http.ResponseEntity<PortfolioDTO>	putUpdatePortfolio(@Valid CreateUpdatePortfolioDTO data, PortfolioRequestContext context)	Returns an updated Portfolio.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PortfolioApiController

public PortfolioApiController()

Method Details

getPortfolioForPortfolioNumber

@GetMapping("/get")
public org.springframework.http.ResponseEntity<PortfolioDTO> getPortfolioForPortfolioNumber(@ResolvedPortfolio
 PortfolioRequestContext context)

Returns a ResponseEntity containing a PortfolioDTO.

Parameters:

context - PortfolioRequestContext

Returns:

ResponseEntity

getPortfolioReport

@GetMapping(value="/get-report",
            produces="application/zip")
public org.springframework.http.ResponseEntity<org.springframework.core.io.ByteArrayResource> getPortfolioReport(@ResolvedPortfolio
 PortfolioRequestContext context)
                                                                                                          throws IOException

Generates a zip archive containing account reports for all accounts in the given portfolio.

Parameters:

context - PortfolioRequestContext

Returns:

ResponseEntity with ByteArrayResource for download

Throws:

IOException - io file exception

postCreateNewPortfolio

@PostMapping("/create-portfolio")
public org.springframework.http.ResponseEntity<PortfolioDTO> postCreateNewPortfolio(@Valid @RequestBody
 @Valid CreateUpdatePortfolioDTO data,
 @AuthenticatedUser
 AuthenticatedUserRef userRef)

Returns a Portfolio.

Parameters:

data - CreateUpdatePortfolioDTO

userRef - AuthenticatedUserRef

Returns:

ResponseEntity

putUpdatePortfolio

@PutMapping("/update-portfolio")
public org.springframework.http.ResponseEntity<PortfolioDTO> putUpdatePortfolio(@Valid @RequestBody
 @Valid CreateUpdatePortfolioDTO data,
 @ResolvedPortfolio
 PortfolioRequestContext context)

Returns an updated Portfolio.

Parameters:

data - CreateUpdatePortfolioDTO

context - PortfolioRequestContext

Returns:

ResponseEntity

deletePortfolio

@DeleteMapping("/delete-portfolio")
public org.springframework.http.ResponseEntity<Void> deletePortfolio(@ResolvedPortfolio
 PortfolioRequestContext context)

Deletes an Portfolio with the matching number.

Parameters:

context - PortfolioRequestContext

Returns:

ResponseEntity