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 UCSBOrganization

Constructor Summary

Constructors

Constructor	Description
UCSBOrganizationController()

Method Summary

Modifier and Type	Method	Description
Iterable<UCSBOrganization>	allOrganizations()	This method returns a list of all UCSBOrganizations.
UCSBOrganization	getById(String code)	This method returns a single Organization.
UCSBOrganization	postOrganization(String orgCode, String orgTranslationShort, String orgTranslation, boolean inactive)	This method creates a new UCSBOrganization.

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

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 UCSBOrganization. Accessible only to users with the role "ROLE_ADMIN".

Parameters:

orgCode - code of the organization

orgTranslationShort - short translation of the organization

orgTranslation - full translation of the organization

inactive - whether or not the organization is inactive

Returns:

the saved UCSBOrganization

getById

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

This method returns a single Organization.

Parameters:

code - code of the Organization

Returns:

a single Organization