Package dev.vernite.vernite.status

Class StatusController

java.lang.Object

dev.vernite.vernite.status.StatusController

@RestController
@RequestMapping("/project/{projectId}/status")
public class StatusController
extends Object

Rest controller for performing CRUD operations on Status entities.

Constructor Summary

Constructors

Constructor	Description
StatusController()

Method Summary

Modifier and Type	Method	Description
Status	create(@NotNull User user, long projectId, @Valid CreateStatus create)	Creates new status for project with given ID.
void	delete(@NotNull User user, long projectId, long id)	Deletes status with given ID.
Status	get(@NotNull User user, long projectId, long id)	Retrieves status with given ID.
List<Status>	getAll(@NotNull User user, long projectId)	Retrieves all statuses for project with given ID.
Status	update(@NotNull User user, long projectId, long id, @Valid UpdateStatus update)	Updates status with given ID.

Methods inherited from class java.lang.Object

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

Constructor Details

StatusController

public StatusController()

Method Details

getAll

@GetMapping
public List<Status> getAll(@NotNull
 @NotNull User user,
 @PathVariable
 long projectId)

Retrieves all statuses for project with given ID. Statuses will be ordered by ordinal number.

Parameters:

user - logged in user

projectId - ID of project

Returns:

list of statuses

create

@PostMapping
public Status create(@NotNull
 @NotNull User user,
 @PathVariable
 long projectId,
 @RequestBody @Valid
 @Valid CreateStatus create)

Creates new status for project with given ID.

Parameters:

user - logged in user

projectId - ID of project

create - data for new status

Returns:

newly created status

get

@GetMapping("/{id}")
public Status get(@NotNull
 @NotNull User user,
 @PathVariable
 long projectId,
 @PathVariable
 long id)

Retrieves status with given ID.

Parameters:

user - logged in user

projectId - ID of project

id - ID of status

Returns:

status with given ID

update

@PutMapping("/{id}")
public Status update(@NotNull
 @NotNull User user,
 @PathVariable
 long projectId,
 @PathVariable
 long id,
 @RequestBody @Valid
 @Valid UpdateStatus update)

Updates status with given ID. Performs partial update using only supplied fields from request body.

Parameters:

user - logged in user

projectId - ID of project

id - ID of status

update - data to update

Returns:

updated status

delete

@DeleteMapping("/{id}")
public void delete(@NotNull
 @NotNull User user,
 @PathVariable
 long projectId,
 @PathVariable
 long id)

Deletes status with given ID. Status must be empty.

Parameters:

user - logged in user

projectId - ID of project

id - ID of status