Class WatchlistApiController

java.lang.Object

com.bluebell.greenhouse.planter.controllers.watchlist.WatchlistApiController

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

API controller for Watchlist.

Version:

3.0.6

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
WatchlistApiController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	deleteWatchlist(WatchlistRequestContext context)	Deletes an existing Watchlist.
org.springframework.http.ResponseEntity<WatchlistDTO>	getWatchlist(WatchlistRequestContext context)	Returns the matching Watchlist for the current User.
org.springframework.http.ResponseEntity<List<WatchlistDTO>>	getWatchlistsForCurrentUser(AuthenticatedUserRef userRef)	Returns all Watchlists for the current User.
org.springframework.http.ResponseEntity<WatchlistDTO>	postCreateWatchlist(@Valid CreateUpdateWatchlistDTO data, AuthenticatedUserRef userRef)	Creates a new Watchlist.
org.springframework.http.ResponseEntity<WatchlistDTO>	putUpdateWatchlist(@Valid CreateUpdateWatchlistDTO data, WatchlistRequestContext context)	Updates an existing Watchlist.

Methods inherited from class Object

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

Constructor Details

WatchlistApiController

public WatchlistApiController()

Method Details

getWatchlistsForCurrentUser

@GetMapping("/get-for-current-user")
public org.springframework.http.ResponseEntity<List<WatchlistDTO>> getWatchlistsForCurrentUser(@AuthenticatedUser
 AuthenticatedUserRef userRef)

Returns all Watchlists for the current User.

Parameters:

userRef - AuthenticatedUserRef

Returns:

ResponseEntity

getWatchlist

@GetMapping("/get")
public org.springframework.http.ResponseEntity<WatchlistDTO> getWatchlist(@ResolvedWatchlist
 WatchlistRequestContext context)

Returns the matching Watchlist for the current User.

Parameters:

context - WatchlistRequestContext

Returns:

ResponseEntity

postCreateWatchlist

@PostMapping("/create-watchlist")
public org.springframework.http.ResponseEntity<WatchlistDTO> postCreateWatchlist(@Valid @RequestBody
 @Valid CreateUpdateWatchlistDTO data,
 @AuthenticatedUser
 AuthenticatedUserRef userRef)

Creates a new Watchlist.

Parameters:

data - CreateUpdateWatchlistDTO

userRef - AuthenticatedUserRef

Returns:

ResponseEntity

putUpdateWatchlist

@PutMapping("/update-watchlist")
public org.springframework.http.ResponseEntity<WatchlistDTO> putUpdateWatchlist(@Valid @RequestBody
 @Valid CreateUpdateWatchlistDTO data,
 @ResolvedWatchlist
 WatchlistRequestContext context)

Updates an existing Watchlist.

Parameters:

data - CreateUpdateWatchlistDTO

context - WatchlistRequestContext

Returns:

ResponseEntity

deleteWatchlist

@DeleteMapping("/delete-watchlist")
public org.springframework.http.ResponseEntity<Void> deleteWatchlist(@ResolvedWatchlist
 WatchlistRequestContext context)

Deletes an existing Watchlist.

Parameters:

context - WatchlistRequestContext

Returns:

ResponseEntity