Class RecurringNotificationApiController

java.lang.Object

com.bluebell.greenhouse.planter.controllers.notification.RecurringNotificationApiController

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

API controller for RecurringNotification.

Version:

3.0.6

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
RecurringNotificationApiController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	deleteRecurringNotification(RecurringNotificationRequestContext context)	Deletes a RecurringNotification with the matching type.
org.springframework.http.ResponseEntity<RecurringNotificationDTO>	getRecurringNotificationByType(RecurringNotificationRequestContext context)	Returns the current user's RecurringNotification for the given type.
org.springframework.http.ResponseEntity<List<RecurringNotificationDTO>>	getRecurringNotificationsForCurrentUser(AuthenticatedUserRef userRef)	Returns the current user's RecurringNotifications.
org.springframework.http.ResponseEntity<RecurringNotificationDTO>	postCreateRecurringNotification(@Valid CreateUpdateRecurringNotificationDTO data, AuthenticatedUserRef userRef)	Creates a RecurringNotification.
org.springframework.http.ResponseEntity<RecurringNotificationDTO>	putUpdateRecurringNotification(@Valid CreateUpdateRecurringNotificationDTO data, RecurringNotificationRequestContext context)	Updates an existing RecurringNotification.

Methods inherited from class Object

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

Constructor Details

RecurringNotificationApiController

public RecurringNotificationApiController()

Method Details

getRecurringNotificationsForCurrentUser

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

Returns the current user's RecurringNotifications.

Parameters:

userRef - AuthenticatedUserRef

Returns:

ResponseEntity

getRecurringNotificationByType

@GetMapping("/get-by-type")
public org.springframework.http.ResponseEntity<RecurringNotificationDTO> getRecurringNotificationByType(@ResolvedRecurringNotification
 RecurringNotificationRequestContext context)

Returns the current user's RecurringNotification for the given type.

Parameters:

context - RecurringNotificationRequestContext

Returns:

ResponseEntity

postCreateRecurringNotification

@PostMapping("/create-recurring-notification")
public org.springframework.http.ResponseEntity<RecurringNotificationDTO> postCreateRecurringNotification(@Valid @RequestBody
 @Valid CreateUpdateRecurringNotificationDTO data,
 @AuthenticatedUser
 AuthenticatedUserRef userRef)

Creates a RecurringNotification.

Parameters:

data - CreateUpdateRecurringNotificationDTO

userRef - AuthenticatedUserRef

Returns:

ResponseEntity

putUpdateRecurringNotification

@PutMapping("/update-recurring-notification")
public org.springframework.http.ResponseEntity<RecurringNotificationDTO> putUpdateRecurringNotification(@Valid @RequestBody
 @Valid CreateUpdateRecurringNotificationDTO data,
 @ResolvedRecurringNotification
 RecurringNotificationRequestContext context)

Updates an existing RecurringNotification.

Parameters:

data - CreateUpdateRecurringNotificationDTO

context - RecurringNotificationRequestContext

Returns:

ResponseEntity

deleteRecurringNotification

@DeleteMapping("/delete-recurring-notification")
public org.springframework.http.ResponseEntity<Void> deleteRecurringNotification(@ResolvedRecurringNotification
 RecurringNotificationRequestContext context)

Deletes a RecurringNotification with the matching type.

Parameters:

context - RecurringNotificationRequestContext

Returns:

ResponseEntity