<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (15) on Sun Jan 24 17:03:02 CET 2021 --> <title>GroupController (restservice 1.0-SNAPSHOT API)</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="dc.created" content="2021-01-24"> <meta name="description" content="declaration: package: com.plannaplan.controllers, class: GroupController"> <meta name="generator" content="javadoc/ClassWriterImpl"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> </head> <body class="class-declaration-page"> <script type="text/javascript">var data = {"i0":10,"i1":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "alt-color"; var rowColor = "row-color"; var tableTab = "table-tab"; var activeTableTab = "active-table-tab"; var pathtoroot = "../../../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <div class="flex-box"> <header role="banner" class="flex-header"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar.top"> <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> <li><a href="../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="nav-bar-cell1-rev">Class</li> <li><a href="class-use/GroupController.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="sub-nav"> <div> <ul class="sub-nav-list"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <div class="nav-list-search"><label for="search">SEARCH:</label> <input type="text" id="search" value="search" disabled="disabled"> <input type="reset" id="reset" value="reset" disabled="disabled"> </div> </div> <!-- ========= END OF TOP NAVBAR ========= --> <span class="skip-nav" id="skip.navbar.top"> <!-- --> </span></nav> </header> <div class="flex-content"> <main role="main"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.plannaplan.controllers</a></div> <h1 title="Class GroupController" class="title">Class GroupController</h1> </div> <div class="inheritance" title="Inheritance Tree">java.lang.Object <div class="inheritance">com.plannaplan.controllers.GroupController</div> </div> <section class="description"> <hr> <pre>@RestController @CrossOrigin @RequestMapping("/api/v1/groups") public class <span class="type-name-label">GroupController</span> extends java.lang.Object</pre> <div class="block">Rest controller to Groups related endpoints. More detailed api docs is available via swagger</div> </section> <section class="summary"> <ul class="summary-list"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <li> <section class="constructor-summary" id="constructor.summary"> <h2>Constructor Summary</h2> <div class="member-summary"> <table class="summary-table"> <caption><span>Constructors</span></caption> <thead> <tr> <th class="col-first" scope="col">Constructor</th> <th class="col-last" scope="col">Description</th> </tr> </thead> <tbody> <tr class="alt-color"> <th class="col-constructor-name" scope="row"><code><span class="member-name-link"><a href="#%3Cinit%3E()">GroupController</a></span>()</code></th> <td class="col-last"> </td> </tr> </tbody> </table> </div> </section> </li> <!-- ========== METHOD SUMMARY =========== --> <li> <section class="method-summary" id="method.summary"> <h2>Method Summary</h2> <div class="member-summary" id="method-summary-table"> <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="table-tab" onclick="show(8);">Concrete Methods</button></div> <div id="method-summary-table.tabpanel" role="tabpanel"> <table class="summary-table" aria-labelledby="t0"> <thead> <tr> <th class="col-first" scope="col">Modifier and Type</th> <th class="col-second" scope="col">Method</th> <th class="col-last" scope="col">Description</th> </tr> </thead> <tbody> <tr class="alt-color" id="i0"> <td class="col-first"><code>org.springframework.http.ResponseEntity<<a href="../responses/models/CourseWithGroupsResponse.html" title="class in com.plannaplan.responses.models">CourseWithGroupsResponse</a><? extends <a href="../responses/models/GroupDefaultResponse.html" title="class in com.plannaplan.responses.models">GroupDefaultResponse</a>>></code></td> <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getCourses(java.lang.Long,java.lang.Boolean,java.lang.Boolean)">getCourses</a></span>​(java.lang.Long id, java.lang.Boolean capacity, java.lang.Boolean takenPlaces)</code></th> <td class="col-last"> </td> </tr> <tr class="row-color" id="i1"> <td class="col-first"><code>org.springframework.http.ResponseEntity<java.lang.String></code></td> <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#updateCapacity(java.lang.Long,java.lang.Integer)">updateCapacity</a></span>​(java.lang.Long id, java.lang.Integer newcapacity)</code></th> <td class="col-last"> </td> </tr> </tbody> </table> </div> </div> <div class="inherited-list"> <h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <li> <section class="constructor-details" id="constructor.detail"> <h2>Constructor Details</h2> <ul class="member-list"> <li> <section class="detail" id="<init>()"> <h3>GroupController</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="member-name">GroupController</span>()</div> </section> </li> </ul> </section> </li> <!-- ============ METHOD DETAIL ========== --> <li> <section class="method-details" id="method.detail"> <h2>Method Details</h2> <ul class="member-list"> <li> <section class="detail" id="getCourses(java.lang.Long,java.lang.Boolean,java.lang.Boolean)"> <h3>getCourses</h3> <div class="member-signature"><span class="annotations">@GetMapping("/course/{id}") </span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<<a href="../responses/models/CourseWithGroupsResponse.html" title="class in com.plannaplan.responses.models">CourseWithGroupsResponse</a><? extends <a href="../responses/models/GroupDefaultResponse.html" title="class in com.plannaplan.responses.models">GroupDefaultResponse</a>>></span> <span class="member-name">getCourses</span>​(<span class="parameters">@PathVariable(name="id") java.lang.Long id, @RequestParam(name="capacity",defaultValue="true") java.lang.Boolean capacity, @RequestParam(name="takenPlaces",defaultValue="false") java.lang.Boolean takenPlaces)</span></div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>id</code> - course to display with groups</dd> <dd><code>capacity</code> - should include capaticty in response</dd> <dd><code>takenPlaces</code> - should include takenPlaces in response</dd> <dt>Returns:</dt> <dd>CourseWithGroupsResponse</dd> </dl> </section> </li> <li> <section class="detail" id="updateCapacity(java.lang.Long,java.lang.Integer)"> <h3>updateCapacity</h3> <div class="member-signature"><span class="annotations">@PutMapping("/{id}/capacity") @PreAuthorize("hasRole(\'ROLE_DEANERY\')") </span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<java.lang.String></span> <span class="member-name">updateCapacity</span>​(<span class="parameters">@PathVariable(name="id",required=true) java.lang.Long id, @RequestParam(name="newcapacity",required=true) java.lang.Integer newcapacity)</span></div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>id</code> - group id to change capacity</dd> <dd><code>newcapacity</code> - new capacity to insert</dd> <dt>Returns:</dt> <dd>ResponseEntity was action success</dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> <footer role="contentinfo"> <nav role="navigation"> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottom-nav" id="navbar.bottom"> <div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation"> <li><a href="../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="nav-bar-cell1-rev">Class</li> <li><a href="class-use/GroupController.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="sub-nav"> <div> <ul class="sub-nav-list"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> </div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <span class="skip-nav" id="skip.navbar.bottom"> <!-- --> </span></nav> <p class="legal-copy"><small>Copyright © 2021. All rights reserved.</small></p> </footer> </div> </div> </body> </html>