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/ucsborganizations")
@RestController
public class UCSBOrganizationController
extends ApiController

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	deleteOrgs(String orgCode)	Delete an organization.
UCSBOrganization	getById(String orgCode)	This method returns a single organization.
UCSBOrganization	postOrgs(String orgCode, String orgTranslationShort, String orgTranslation, boolean inactive)	This method creates a new organiation.
UCSBOrganization	updateOrgs(String orgCode, @Valid UCSBOrganization incoming)	Update a single org.

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 - code of the organization

Returns:

a single organization

postOrgs

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

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

Parameters:

orgCode - code of the organization

orgTranslationShort - short translation of the organization

orgTranslation - translation of the organization

inactive - whether the organization is inactive

Returns:

the newly created organization

deleteOrgs

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@DeleteMapping("")
public Object deleteOrgs(@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

updateOrgs

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

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

Parameters:

orgCode - the code of the org to update

incoming - the new org contents

Returns:

the updated org object