Package org.bremersee.groupman.api

Interface GroupAdminControllerApi

All Known Implementing Classes:
GroupAdminControllerMock
@Valid public interface GroupAdminControllerApi
The group admin controller api.
Author:
Christian Bremer

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.http.ResponseEntity<org.bremersee.groupman.model.Group>
    addGroup(@Valid org.bremersee.groupman.model.Group group)
    Add group.
    org.springframework.http.ResponseEntity<org.bremersee.groupman.model.Group>
    findGroupById(String id)
    Find group by id.
    org.springframework.http.ResponseEntity<List<org.bremersee.groupman.model.Group>>
    findGroups()
    Gets groups.
    org.springframework.http.ResponseEntity<List<org.bremersee.groupman.model.Group>>
    findGroupsByIds(List<String> id)
    Find groups by ids.
    org.springframework.http.ResponseEntity<org.bremersee.groupman.model.Group>
    modifyGroup(String id, @Valid org.bremersee.groupman.model.Group group)
    Modify group.
    org.springframework.http.ResponseEntity<org.bremersee.groupman.model.Group>
    removeGroup(String id)
    Remove group.

  • Method Details

    • findGroups

      @RequestMapping(value="/api/admin/groups", produces="application/json", method=GET) org.springframework.http.ResponseEntity<List<org.bremersee.groupman.model.Group>> findGroups()
      Gets groups.
      Returns:
      the groups

    • addGroup

      @RequestMapping(value="/api/admin/groups", produces="application/json", consumes="application/json", method=POST) org.springframework.http.ResponseEntity<org.bremersee.groupman.model.Group> addGroup(@Valid @RequestBody @Valid org.bremersee.groupman.model.Group group)
      Add group.
      Parameters:
      group - the group
      Returns:
      the response entity

    • findGroupById

      @RequestMapping(value="/api/admin/groups/{id}", produces="application/json", method=GET) org.springframework.http.ResponseEntity<org.bremersee.groupman.model.Group> findGroupById(@PathVariable("id") String id)
      Find group by id.
      Parameters:
      id - the id
      Returns:
      the response entity

    • modifyGroup

      @RequestMapping(value="/api/admin/groups/{id}", produces="application/json", consumes="application/json", method=PUT) org.springframework.http.ResponseEntity<org.bremersee.groupman.model.Group> modifyGroup(@PathVariable("id") String id, @Valid @RequestBody @Valid org.bremersee.groupman.model.Group group)
      Modify group.
      Parameters:
      id - the id
      group - the group
      Returns:
      the response entity

    • removeGroup

      @RequestMapping(value="/api/admin/groups/{id}", method=DELETE) org.springframework.http.ResponseEntity<org.bremersee.groupman.model.Group> removeGroup(@PathVariable("id") String id)
      Remove group.
      Parameters:
      id - the id
      Returns:
      the response entity

    • findGroupsByIds

      @RequestMapping(value="/api/admin/groups/f", produces="application/json", method=GET) org.springframework.http.ResponseEntity<List<org.bremersee.groupman.model.Group>> findGroupsByIds(@RequestParam(value="id",required=false) List<String> id)
      Find groups by ids.
      Parameters:
      id - the list of ids
      Returns:
      the response entity