Package edu.ucsb.cs156.example.controllers

Class UCSBOrganizationController

java.lang.Object

edu.ucsb.cs156.example.controllers.ApiController

edu.ucsb.cs156.example.controllers.UCSBOrganizationController

@RequestMapping("/api/ucsborganization")
@RestController
public class UCSBOrganizationController
extends ApiController

This is a REST controller for UCSBOrganizations

Constructor Summary

Constructors

Constructor	Description
UCSBOrganizationController()

Method Summary

Modifier and Type	Method	Description
Iterable<UCSBOrganization>	allOrganizations()	This method returns a list of all ucsborganizations.
Object	deleteOrganization(String orgCode)	Delete an organization.
UCSBOrganization	getById(String orgCode)	This method returns a single organization.
UCSBOrganization	postOrganization(String orgCode, String orgTranslationShort, String orgTranslation, boolean inactive)	This method creates a new organization.
UCSBOrganization	updateOrganization(String orgCode, @Valid UCSBOrganization incoming)	Update a single organization.

Methods inherited from class edu.ucsb.cs156.example.controllers.ApiController

genericMessage, getCurrentUser, handleGenericException

Methods inherited from class java.lang.Object

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

Constructor Details

UCSBOrganizationController

public UCSBOrganizationController()

Method Details

allOrganizations

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/all")
public Iterable<UCSBOrganization> allOrganizations()

This method returns a list of all ucsborganizations.

Returns:

a list of all ucsborganizations

getById

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("")
public UCSBOrganization getById(@RequestParam
 String orgCode)

This method returns a single organization.

Parameters:

orgCode - org code of the organization

Returns:

a single organization

postOrganization

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@PostMapping("/post")
public UCSBOrganization postOrganization(@RequestParam
 String orgCode,
 @RequestParam
 String orgTranslationShort,
 @RequestParam
 String orgTranslation,
 @RequestParam
 boolean inactive)

This method creates a new organization. Accessible only to users with the role "ROLE_ADMIN".

Parameters:

orgCode - code of the organization

orgTranslationShort - short translation of the organization name

orgTranslation - the full translation of the organization name

inactive - whether or not the organization is inactive

Returns:

the save organization

deleteOrganization

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@DeleteMapping("")
public Object deleteOrganization(@RequestParam
 String orgCode)

Delete an organization. Accessible only to users with the role "ROLE_ADMIN".

Parameters:

orgCode - code of the organization

Returns:

a message indiciating the organization was deleted

updateOrganization

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@PutMapping("")
public UCSBOrganization updateOrganization(@RequestParam
 String orgCode,
 @RequestBody @Valid
 @Valid UCSBOrganization incoming)

Update a single organization. Accessible only to users with the role "ROLE_ADMIN".

Parameters:

orgCode - code of the organization

incoming - the new organization contents

Returns:

the updated organization object