Class StrategyApiController

java.lang.Object

com.bluebell.greenhouse.planter.controllers.strategy.StrategyApiController

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

API controller for Strategy.

Version:

3.0.6

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
StrategyApiController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	deleteStrategy(String strategyUid)	Deletes a Strategy.
org.springframework.http.ResponseEntity<StrategyDTO>	getStrategy(String strategyUid, String referenceCode)	Returns a ResponseEntity containing a StrategyDTO.
org.springframework.http.ResponseEntity<StrategyDTO>	postCreateNewStrategy(@Valid CreateUpdateStrategyDTO data)	Creates a new Strategy.
org.springframework.http.ResponseEntity<StrategyDTO>	putUpdateStrategy(String strategyUid, @Valid CreateUpdateStrategyDTO data)	Updates an existing Strategy.
org.springframework.http.ResponseEntity<StrategyDTO>	putUpdateStrategyAccountAssignments(String strategyUid, @Valid UpdateStrategyAccountsDTO data, AuthenticatedUserRef userRef)	Synchronizes the accounts assigned to an existing Strategy.
org.springframework.http.ResponseEntity<PaginatedStrategyDTO>	searchStrategies(StrategySearchRequest searchRequest)	Returns a ResponseEntity containing all matching StrategyDTOs.

Methods inherited from class Object

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

Constructor Details

StrategyApiController

public StrategyApiController()

Method Details

getStrategy

@GetMapping("/get")
public org.springframework.http.ResponseEntity<StrategyDTO> getStrategy(@RequestParam(name="strategyUid",required=false)
 String strategyUid,
 @RequestParam(name="strategyReferenceCode",required=false)
 String referenceCode)

Returns a ResponseEntity containing a StrategyDTO.

Parameters:

strategyUid - strategy uid

referenceCode - strategy reference code

Returns:

ResponseEntity

searchStrategies

@GetMapping("/search")
public org.springframework.http.ResponseEntity<PaginatedStrategyDTO> searchStrategies(@ModelAttribute
 StrategySearchRequest searchRequest)

Returns a ResponseEntity containing all matching StrategyDTOs.

Parameters:

searchRequest - StrategySearchRequest

Returns:

ResponseEntity

postCreateNewStrategy

@PostMapping("/create")
public org.springframework.http.ResponseEntity<StrategyDTO> postCreateNewStrategy(@Valid @RequestBody
 @Valid CreateUpdateStrategyDTO data)

Creates a new Strategy.

Parameters:

data - CreateUpdateStrategyDTO

Returns:

ResponseEntity

putUpdateStrategy

@PutMapping("/update")
public org.springframework.http.ResponseEntity<StrategyDTO> putUpdateStrategy(@RequestParam("strategyUid")
 String strategyUid,
 @Valid @RequestBody
 @Valid CreateUpdateStrategyDTO data)

Updates an existing Strategy.

Parameters:

strategyUid - strategy uid

data - CreateUpdateStrategyDTO

Returns:

ResponseEntity

putUpdateStrategyAccountAssignments

@PutMapping("/update-account-assignments")
public org.springframework.http.ResponseEntity<StrategyDTO> putUpdateStrategyAccountAssignments(@RequestParam("strategyUid")
 String strategyUid,
 @Valid @RequestBody
 @Valid UpdateStrategyAccountsDTO data,
 @AuthenticatedUser
 AuthenticatedUserRef userRef)

Synchronizes the accounts assigned to an existing Strategy.

Parameters:

strategyUid - strategy uid

data - UpdateStrategyAccountsDTO

userRef - AuthenticatedUserRef

Returns:

ResponseEntity

deleteStrategy

@DeleteMapping("/delete")
public org.springframework.http.ResponseEntity<Void> deleteStrategy(@RequestParam("strategyUid")
 String strategyUid)

Deletes a Strategy.

Parameters:

strategyUid - strategy uid

Returns:

ResponseEntity