Class PositionApiController

java.lang.Object

com.bluebell.greenhouse.planter.controllers.position.PositionApiController

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

Api controller for Position.

Version:

3.0.6

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
PositionApiController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	deletePosition(PositionRequestContext context)	Deletes an existing Position.
org.springframework.http.ResponseEntity<PositionDTO>	getPosition(PositionRequestContext context)	Returns a Position for the given position number.
org.springframework.http.ResponseEntity<PositionInsights>	getPositionInsights(PositionRequestContext context)	Returns PositionInsights for the given position number.
org.springframework.http.ResponseEntity<org.springframework.core.io.ByteArrayResource>	getPositionReport(AccountRequestContext context, String headerProfile)	Generates a csv report for the given account's positions.
org.springframework.http.ResponseEntity<PositionDTO>	postCreatePosition(@Valid CreateUpdatePositionDTO data, AccountRequestContext context)	Creates a new Position for the given account number.
org.springframework.http.ResponseEntity<Boolean>	postImportPositions(AccountRequestContext context, ImportPositionsRequest importRequest, org.springframework.web.multipart.MultipartFile file)	Imports positions from a file.
org.springframework.http.ResponseEntity<Integer>	postRecalculatePositions(AccountRequestContext context)	Recalculates all positions for the given account number.
org.springframework.http.ResponseEntity<PositionDTO>	putUpdatePosition(@Valid CreateUpdatePositionDTO data, PositionRequestContext context)	Updates an existing Position.
org.springframework.http.ResponseEntity<PaginatedPositionSummaryDTO>	searchPositions(AccountRequestContext context, PositionSearchRequest searchRequest)	Returns paginated positions filtered by the given criteria.

Methods inherited from class Object

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

Constructor Details

PositionApiController

public PositionApiController()

Method Details

getPosition

@GetMapping("/get")
public org.springframework.http.ResponseEntity<PositionDTO> getPosition(@ResolvedPosition
 PositionRequestContext context)

Returns a Position for the given position number.

Parameters:

context - PositionRequestContext

Returns:

ResponseEntity

getPositionInsights

@GetMapping("/get-insights")
public org.springframework.http.ResponseEntity<PositionInsights> getPositionInsights(@ResolvedPosition
 PositionRequestContext context)

Returns PositionInsights for the given position number.

Parameters:

context - PositionRequestContext

Returns:

ResponseEntity

searchPositions

@GetMapping("/search")
public org.springframework.http.ResponseEntity<PaginatedPositionSummaryDTO> searchPositions(@ResolvedAccount
 AccountRequestContext context,
 @ModelAttribute
 PositionSearchRequest searchRequest)

Returns paginated positions filtered by the given criteria.

Parameters:

context - AccountRequestContext

searchRequest - PositionSearchRequest

Returns:

ResponseEntity

getPositionReport

@GetMapping(value="/get-report",
            produces="text/csv")
public org.springframework.http.ResponseEntity<org.springframework.core.io.ByteArrayResource> getPositionReport(@ResolvedAccount
 AccountRequestContext context,
 @RequestParam(value="reportHeaders",defaultValue="minimal")
 String headerProfile)
                                                                                                         throws IOException

Generates a csv report for the given account's positions.

Parameters:

context - AccountRequestContext

headerProfile - header profile

Returns:

ResponseEntity

Throws:

IOException - io exception

postImportPositions

@PostMapping(value="/import-positions",
             consumes="multipart/form-data")
public org.springframework.http.ResponseEntity<Boolean> postImportPositions(@ResolvedAccount
 AccountRequestContext context,
 @ModelAttribute
 ImportPositionsRequest importRequest,
 @RequestPart("file")
 org.springframework.web.multipart.MultipartFile file)
                                                                     throws IOException

Imports positions from a file.

Parameters:

context - AccountRequestContext

importRequest - ImportPositionsRequest

file - MultipartFile

Returns:

ResponseEntity

Throws:

IOException - io exception

postRecalculatePositions

@PostMapping("/recalculate-positions")
public org.springframework.http.ResponseEntity<Integer> postRecalculatePositions(@ResolvedAccount
 AccountRequestContext context)

Recalculates all positions for the given account number.

Parameters:

context - AccountRequestContext

Returns:

ResponseEntity

postCreatePosition

@PostMapping("/create")
public org.springframework.http.ResponseEntity<PositionDTO> postCreatePosition(@Valid @RequestBody
 @Valid CreateUpdatePositionDTO data,
 @ResolvedAccount
 AccountRequestContext context)

Creates a new Position for the given account number.

Parameters:

data - CreateUpdatePositionDTO

context - AccountRequestContext

Returns:

ResponseEntity

putUpdatePosition

@PutMapping("/update")
public org.springframework.http.ResponseEntity<PositionDTO> putUpdatePosition(@Valid @RequestBody
 @Valid CreateUpdatePositionDTO data,
 @ResolvedPosition
 PositionRequestContext context)

Updates an existing Position.

Parameters:

data - CreateUpdatePositionDTO

context - PositionRequestContext

Returns:

ResponseEntity

deletePosition

@DeleteMapping("/delete")
public org.springframework.http.ResponseEntity<Void> deletePosition(@ResolvedPosition
 PositionRequestContext context)

Deletes an existing Position.

Parameters:

context - PositionRequestContext

Returns:

ResponseEntity