Google Git
Sign in
apache / archiva-web-content / 1b7e811f9aa411dd1b001fe82a147012e4cce823 / . / redback / core / 3.0.0-SNAPSHOT / apidocs / org / apache / archiva / redback / users / AbstractUserQuery.html
blob: ed4d046a5b4e830e31695f582bfb85f8b47a00a4 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AbstractUserQuery (Apache Archiva Redback 3.0.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractUserQuery (Apache Archiva Redback 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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/AbstractUserQuery.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">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.archiva.redback.users</a></div>
<h2 title="Class AbstractUserQuery" class="title">Class AbstractUserQuery</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.archiva.redback.users.AbstractUserQuery</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="ldap/LdapUserQuery.html" title="class in org.apache.archiva.redback.users.ldap">LdapUserQuery</a></code>, <code><a href="memory/SimpleUserQuery.html" title="class in org.apache.archiva.redback.users.memory">SimpleUserQuery</a></code></dd>
</dl>
<hr>
<pre>public abstract class <a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.26">AbstractUserQuery</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></pre>
<div class="block">Abstract Implementation of UserQuery.
Intended to be subclassed by UserManager providers.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.archiva.redback.users.UserQuery">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.archiva.redback.users.<a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></h3>
<code><a href="UserQuery.html#ALLOWED_ORDER_FIELDS">ALLOWED_ORDER_FIELDS</a>, <a href="UserQuery.html#ORDER_BY_EMAIL">ORDER_BY_EMAIL</a>, <a href="UserQuery.html#ORDER_BY_FULLNAME">ORDER_BY_FULLNAME</a>, <a href="UserQuery.html#ORDER_BY_USERNAME">ORDER_BY_USERNAME</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractUserQuery</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<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>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEmail()">getEmail</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the case insensitive substring email criteria.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFirstResult()">getFirstResult</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the index (zero based) of the first result to include.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFullName()">getFullName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the case insensitive substring full name criteria.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxResults()">getMaxResults</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the maximum number of users to return.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrderBy()">getOrderBy</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the property used to order the results of this query.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUsername()">getUsername</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the case insensitive substring user name criteria.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAscending()">isAscending</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if the results should be returned in ascending order.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAscending(boolean)">setAscending</a></span>&#8203;(boolean&nbsp;ascending)</code></th>
<td class="colLast">
<div class="block">Set this to true if the results should be returned in ascending order.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEmail(java.lang.String)">setEmail</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;email)</code></th>
<td class="colLast">
<div class="block">Sets the case insensitive substring email criteria.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFirstResult(int)">setFirstResult</a></span>&#8203;(int&nbsp;firstResult)</code></th>
<td class="colLast">
<div class="block">Sets the index (zero based) of the first result to include.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFullName(java.lang.String)">setFullName</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;fullName)</code></th>
<td class="colLast">
<div class="block">Sets the case insensitive substring full name criteria.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxResults(int)">setMaxResults</a></span>&#8203;(int&nbsp;maxResults)</code></th>
<td class="colLast">
<div class="block">Sets the maximum number of users to return.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOrderBy(java.lang.String)">setOrderBy</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;orderBy)</code></th>
<td class="colLast">
<div class="block">Sets the property used to order the results of this query.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUsername(java.lang.String)">setUsername</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userName)</code></th>
<td class="colLast">
<div class="block">Sets the case insensitive substring user name criteria.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractUserQuery</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.26">AbstractUserQuery</a>()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getUsername()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsername</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.44">getUsername</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#getUsername()">UserQuery</a></code></span></div>
<div class="block">Returns the case insensitive substring user name criteria.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#getUsername()">getUsername</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the username criteria.</dd>
</dl>
</li>
</ul>
<a id="setUsername(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUsername</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.49">setUsername</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#setUsername(java.lang.String)">UserQuery</a></code></span></div>
<div class="block">Sets the case insensitive substring user name criteria.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#setUsername(java.lang.String)">setUsername</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>userName</code> - the username criteria</dd>
</dl>
</li>
</ul>
<a id="getFullName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFullName</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.54">getFullName</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#getFullName()">UserQuery</a></code></span></div>
<div class="block">Returns the case insensitive substring full name criteria.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#getFullName()">getFullName</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the username criteria.</dd>
</dl>
</li>
</ul>
<a id="setFullName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFullName</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.59">setFullName</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;fullName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#setFullName(java.lang.String)">UserQuery</a></code></span></div>
<div class="block">Sets the case insensitive substring full name criteria.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#setFullName(java.lang.String)">setFullName</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fullName</code> - the full name criteria</dd>
</dl>
</li>
</ul>
<a id="getEmail()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEmail</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.64">getEmail</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#getEmail()">UserQuery</a></code></span></div>
<div class="block">Returns the case insensitive substring email criteria.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#getEmail()">getEmail</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the email criteria.</dd>
</dl>
</li>
</ul>
<a id="setEmail(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEmail</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.69">setEmail</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;email)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#setEmail(java.lang.String)">UserQuery</a></code></span></div>
<div class="block">Sets the case insensitive substring email criteria.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#setEmail(java.lang.String)">setEmail</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>email</code> - the email criteria</dd>
</dl>
</li>
</ul>
<a id="getFirstResult()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstResult</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.74">getFirstResult</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#getFirstResult()">UserQuery</a></code></span></div>
<div class="block">Returns the index (zero based) of the first result to include. Useful for paging.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#getFirstResult()">getFirstResult</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the first index</dd>
</dl>
</li>
</ul>
<a id="setFirstResult(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFirstResult</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.79">setFirstResult</a>&#8203;(int&nbsp;firstResult)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#setFirstResult(int)">UserQuery</a></code></span></div>
<div class="block">Sets the index (zero based) of the first result to include. Useful for paging.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#setFirstResult(int)">setFirstResult</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>firstResult</code> - the first index</dd>
</dl>
</li>
</ul>
<a id="getMaxResults()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxResults</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.84">getMaxResults</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#getMaxResults()">UserQuery</a></code></span></div>
<div class="block">Returns the maximum number of users to return.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#getMaxResults()">getMaxResults</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of users to return.</dd>
</dl>
</li>
</ul>
<a id="setMaxResults(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxResults</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.89">setMaxResults</a>&#8203;(int&nbsp;maxResults)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#setMaxResults(int)">UserQuery</a></code></span></div>
<div class="block">Sets the maximum number of users to return.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#setMaxResults(int)">setMaxResults</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxResults</code> - the maximum number of users to return.</dd>
</dl>
</li>
</ul>
<a id="getOrderBy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrderBy</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.94">getOrderBy</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#getOrderBy()">UserQuery</a></code></span></div>
<div class="block">Returns the property used to order the results of this query.
This is one of <a href="UserQuery.html#ORDER_BY_USERNAME"><code>UserQuery.ORDER_BY_USERNAME</code></a>, <a href="UserQuery.html#ORDER_BY_FULLNAME"><code>UserQuery.ORDER_BY_FULLNAME</code></a> or <a href="UserQuery.html#ORDER_BY_EMAIL"><code>UserQuery.ORDER_BY_EMAIL</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#getOrderBy()">getOrderBy</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the order property.</dd>
</dl>
</li>
</ul>
<a id="setOrderBy(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOrderBy</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.99">setOrderBy</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;orderBy)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#setOrderBy(java.lang.String)">UserQuery</a></code></span></div>
<div class="block">Sets the property used to order the results of this query.
This is one of <a href="UserQuery.html#ORDER_BY_USERNAME"><code>UserQuery.ORDER_BY_USERNAME</code></a>, <a href="UserQuery.html#ORDER_BY_FULLNAME"><code>UserQuery.ORDER_BY_FULLNAME</code></a> or <a href="UserQuery.html#ORDER_BY_EMAIL"><code>UserQuery.ORDER_BY_EMAIL</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#setOrderBy(java.lang.String)">setOrderBy</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>orderBy</code> - the order property.</dd>
</dl>
</li>
</ul>
<a id="isAscending()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAscending</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.112">isAscending</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#isAscending()">UserQuery</a></code></span></div>
<div class="block">Returns true if the results should be returned in ascending order.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#isAscending()">isAscending</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ascending</dd>
</dl>
</li>
</ul>
<a id="setAscending(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setAscending</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/users/AbstractUserQuery.html#line.117">setAscending</a>&#8203;(boolean&nbsp;ascending)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="UserQuery.html#setAscending(boolean)">UserQuery</a></code></span></div>
<div class="block">Set this to true if the results should be returned in ascending order.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="UserQuery.html#setAscending(boolean)">setAscending</a></code>&nbsp;in interface&nbsp;<code><a href="UserQuery.html" title="interface in org.apache.archiva.redback.users">UserQuery</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ascending</code> - true if the results should be returned in ascending</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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/AbstractUserQuery.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">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>