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 ucsborgnization.
Object	deleteOrganizations(String orgCode)	Delete a organizations.
UCSBOrganization	getById(String orgCode)	This method returns a single organizations.
UCSBOrganization	postOrganizations(String orgCode, String orgTranslationShort, String orgTranslation, Boolean inactive)	This method creates a new organizations.
UCSBOrganization	updateOrganizations(String orgCode, @Valid UCSBOrganization incoming)	Update a single organizations.

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 ucsborgnization.

Returns:

a list of all ucsborgnization

getById

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

This method returns a single organizations.

Parameters:

orgCode - code of the organizations

Returns:

a single organizations

postOrganizations

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

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

Parameters:

orgCode - code of the organizations

orgTranslationShort - name of the tranlationshort

orgTranslation - for tranlation

inactive - whether or not the organizations is inactive

Returns:

the save organizations

updateOrganizations

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

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

Parameters:

orgCode - code of the organizations

incoming - the new organizations contents

Returns:

the updated organizations object

deleteOrganizations

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

Delete a organizations. Accessible only to users with the role "ROLE_ADMIN".

Parameters:

orgCode - code of the organizations

Returns:

a message indiciating the organizations was deleted