dokumentacja-plannaplan/dokumentacja-backendu/businesslogic/com/plannaplan/repositories/UserRepository.html
Marcin Woźniak 13f492dc98
Added backedn
Signed-off-by: Marcin Woźniak <y0rune@aol.com>
2021-01-22 17:22:57 +01:00

360 lines
18 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.2) on Fri Jan 22 16:23:18 CET 2021 -->
<title>UserRepository (buisnesslogic 1.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-01-22">
<meta name="description" content="declaration: package: com.plannaplan.repositories, interface: UserRepository">
<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.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UserRepository.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="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="navListSearch"><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 ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.plannaplan.repositories</a></div>
<h1 title="Interface UserRepository" class="title">Interface UserRepository</h1>
</div>
<div class="contentContainer">
<section class="description">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code>org.springframework.data.repository.CrudRepository&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>,&#8203;java.lang.Long&gt;</code>, <code>org.springframework.data.jpa.repository.JpaRepository&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>,&#8203;java.lang.Long&gt;</code>, <code>org.springframework.data.repository.PagingAndSortingRepository&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>,&#8203;java.lang.Long&gt;</code>, <code>org.springframework.data.repository.query.QueryByExampleExecutor&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</code>, <code>org.springframework.data.repository.Repository&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>,&#8203;java.lang.Long&gt;</code></dd>
</dl>
<hr>
<pre>@Repository
public interface <span class="typeNameLabel">UserRepository</span>
extends org.springframework.data.jpa.repository.JpaRepository&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>,&#8203;java.lang.Long&gt;</pre>
<div class="block">UserRepository.getByAuthority: Return list of: SELECT * FROM User WHERE email
= i.
Where i, ?1 are equale to variables.
UserRepository.getByToken: Return list of: SELECT * FROM User WHERE token =
i.
Where i, ?1 are equale to variables.
UserRepository.searchForUsers: Return list of: SELECT * FROM User WHERE (name
LIKE %?1% OR surname LIKE %?1%).
Where i, ?1 are equale to variables.
UserRepository.searchForUsers with role: Return list of: SELECT * FROM User
WHERE (name LIKE %?1% OR surname LIKE %?1%) AND role=?2").
Where i, ?1 are equale to variables.</div>
</section>
<section class="summary">
<ul class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>java.util.List&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllByRole(com.plannaplan.types.UserRoles)">getAllByRole</a></span>&#8203;(<a href="../types/UserRoles.html" title="enum in com.plannaplan.types">UserRoles</a>&nbsp;role)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>java.util.Optional&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByAuthority(java.lang.String)">getByAuthority</a></span>&#8203;(java.lang.String&nbsp;authority)</code></th>
<td class="colLast">
<div class="block">return user by given authority</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>java.util.Optional&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByEmail(java.lang.String)">getByEmail</a></span>&#8203;(java.lang.String&nbsp;authority)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>java.util.Optional&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByRefreshToken(java.lang.String)">getByRefreshToken</a></span>&#8203;(java.lang.String&nbsp;refreshToken)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>java.util.Optional&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByToken(java.lang.String)">getByToken</a></span>&#8203;(java.lang.String&nbsp;token)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>java.util.Optional&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByUsosId(java.lang.String)">getByUsosId</a></span>&#8203;(java.lang.String&nbsp;usosId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>java.util.List&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchForUsers(java.lang.String)">searchForUsers</a></span>&#8203;(java.lang.String&nbsp;query)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>java.util.List&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchForUsers(java.lang.String,com.plannaplan.types.UserRoles)">searchForUsers</a></span>&#8203;(java.lang.String&nbsp;query,
<a href="../types/UserRoles.html" title="enum in com.plannaplan.types">UserRoles</a>&nbsp;role)</code></th>
<td class="colLast">
<div class="block">search for user with given query</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.springframework.data.repository.CrudRepository</h3>
<a id="methods.inherited.from.class.org.springframework.data.repository.CrudRepository">
<!-- -->
</a><code>count, delete, deleteAll, deleteAll, deleteById, existsById, findById, save</code></div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.springframework.data.jpa.repository.JpaRepository</h3>
<a id="methods.inherited.from.class.org.springframework.data.jpa.repository.JpaRepository">
<!-- -->
</a><code>deleteAllInBatch, deleteInBatch, findAll, findAll, findAll, findAll, findAllById, flush, getOne, saveAll, saveAndFlush</code></div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.springframework.data.repository.PagingAndSortingRepository</h3>
<a id="methods.inherited.from.class.org.springframework.data.repository.PagingAndSortingRepository">
<!-- -->
</a><code>findAll</code></div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.springframework.data.repository.query.QueryByExampleExecutor</h3>
<a id="methods.inherited.from.class.org.springframework.data.repository.query.QueryByExampleExecutor">
<!-- -->
</a><code>count, exists, findAll, findOne</code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="getByAuthority(java.lang.String)">getByAuthority</a></h3>
<div class="memberSignature"><span class="annotations">@Query("FROM User WHERE email = ?1 OR usosId = ?1")
</span><span class="returnType">java.util.Optional&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</span>&nbsp;<span class="memberName">getByAuthority</span>&#8203;(<span class="arguments">@Param("authority")
java.lang.String&nbsp;authority)</span></div>
<div class="block">return user by given authority</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authority</code> - user usosId or email</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>optional with user if found</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getByEmail(java.lang.String)">getByEmail</a></h3>
<div class="memberSignature"><span class="annotations">@Query("FROM User WHERE email = ?1")
</span><span class="returnType">java.util.Optional&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</span>&nbsp;<span class="memberName">getByEmail</span>&#8203;(<span class="arguments">@Param("authority")
java.lang.String&nbsp;authority)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getByRefreshToken(java.lang.String)">getByRefreshToken</a></h3>
<div class="memberSignature"><span class="annotations">@Query("FROM User WHERE refreshToken = ?1")
</span><span class="returnType">java.util.Optional&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</span>&nbsp;<span class="memberName">getByRefreshToken</span>&#8203;(<span class="arguments">@Param("refreshToken")
java.lang.String&nbsp;refreshToken)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getByToken(java.lang.String)">getByToken</a></h3>
<div class="memberSignature"><span class="annotations">@Query("FROM User WHERE token = ?1")
</span><span class="returnType">java.util.Optional&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</span>&nbsp;<span class="memberName">getByToken</span>&#8203;(<span class="arguments">@Param("token")
java.lang.String&nbsp;token)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="searchForUsers(java.lang.String)">searchForUsers</a></h3>
<div class="memberSignature"><span class="annotations">@Query("FROM User WHERE (name LIKE %?1% OR surname LIKE %?1%)")
</span><span class="returnType">java.util.List&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</span>&nbsp;<span class="memberName">searchForUsers</span>&#8203;(<span class="arguments">@Param("query")
java.lang.String&nbsp;query)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="searchForUsers(java.lang.String,com.plannaplan.types.UserRoles)">searchForUsers</a></h3>
<div class="memberSignature"><span class="annotations">@Query("FROM User WHERE (name LIKE %?1% OR surname LIKE %?1%) AND role=?2")
</span><span class="returnType">java.util.List&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</span>&nbsp;<span class="memberName">searchForUsers</span>&#8203;(<span class="arguments">@Param("query")
java.lang.String&nbsp;query,
@Param("role")
<a href="../types/UserRoles.html" title="enum in com.plannaplan.types">UserRoles</a>&nbsp;role)</span></div>
<div class="block">search for user with given query</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>query</code> - string that will be matched to users name and surname</dd>
<dd><code>role</code> - limits results by role</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list opf results</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getAllByRole(com.plannaplan.types.UserRoles)">getAllByRole</a></h3>
<div class="memberSignature"><span class="annotations">@Query("FROM User WHERE role=?1")
</span><span class="returnType">java.util.List&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</span>&nbsp;<span class="memberName">getAllByRole</span>&#8203;(<span class="arguments">@Param("role")
<a href="../types/UserRoles.html" title="enum in com.plannaplan.types">UserRoles</a>&nbsp;role)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getByUsosId(java.lang.String)">getByUsosId</a></h3>
<div class="memberSignature"><span class="annotations">@Query("FROM User WHERE usosId = ?1")
</span><span class="returnType">java.util.Optional&lt;<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&gt;</span>&nbsp;<span class="memberName">getByUsosId</span>&#8203;(<span class="arguments">@Param("usosId")
java.lang.String&nbsp;usosId)</span></div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UserRepository.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="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2021. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>