| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>UserQuery (Apache Archiva Redback 3.0.0-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="UserQuery (Apache Archiva Redback 3.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/UserQuery.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"> |
| <li><a href="../../../../../org/apache/archiva/redback/users/UserNotFoundException.html" title="class in org.apache.archiva.redback.users"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/archiva/redback/users/UserQuery.html" target="_top">Frames</a></li> |
| <li><a href="UserQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.archiva.redback.users</div> |
| <h2 title="Interface UserQuery" class="title">Interface UserQuery</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/archiva/redback/users/AbstractUserQuery.html" title="class in org.apache.archiva.redback.users">AbstractUserQuery</a>, <a href="../../../../../org/apache/archiva/redback/users/jpa/JpaUserQuery.html" title="class in org.apache.archiva.redback.users.jpa">JpaUserQuery</a>, <a href="../../../../../org/apache/archiva/redback/users/ldap/LdapUserQuery.html" title="class in org.apache.archiva.redback.users.ldap">LdapUserQuery</a>, <a href="../../../../../org/apache/archiva/redback/users/memory/SimpleUserQuery.html" title="class in org.apache.archiva.redback.users.memory">SimpleUserQuery</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.27">UserQuery</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#ALLOWED_ORDER_FIELDS">ALLOWED_ORDER_FIELDS</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#ORDER_BY_EMAIL">ORDER_BY_EMAIL</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#ORDER_BY_FULLNAME">ORDER_BY_FULLNAME</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#ORDER_BY_USERNAME">ORDER_BY_USERNAME</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and 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">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#getEmail--">getEmail</a></span>()</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#getFirstResult--">getFirstResult</a></span>()</code> |
| <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">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#getFullName--">getFullName</a></span>()</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#getMaxResults--">getMaxResults</a></span>()</code> |
| <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">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#getOrderBy--">getOrderBy</a></span>()</code> |
| <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">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#getUsername--">getUsername</a></span>()</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#isAscending--">isAscending</a></span>()</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#setAscending-boolean-">setAscending</a></span>(boolean ascending)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#setEmail-java.lang.String-">setEmail</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#setFirstResult-int-">setFirstResult</a></span>(int firstResult)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#setFullName-java.lang.String-">setFullName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fullName)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#setMaxResults-int-">setMaxResults</a></span>(int maxResults)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#setOrderBy-java.lang.String-">setOrderBy</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> orderBy)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#setUsername-java.lang.String-">setUsername</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName)</code> |
| <div class="block">Sets the case insensitive substring user name criteria.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="ORDER_BY_USERNAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ORDER_BY_USERNAME</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.29">ORDER_BY_USERNAME</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.archiva.redback.users.UserQuery.ORDER_BY_USERNAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ORDER_BY_FULLNAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ORDER_BY_FULLNAME</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.31">ORDER_BY_FULLNAME</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.archiva.redback.users.UserQuery.ORDER_BY_FULLNAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ORDER_BY_EMAIL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ORDER_BY_EMAIL</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.33">ORDER_BY_EMAIL</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.archiva.redback.users.UserQuery.ORDER_BY_EMAIL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ALLOWED_ORDER_FIELDS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ALLOWED_ORDER_FIELDS</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.35">ALLOWED_ORDER_FIELDS</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getUsername--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUsername</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.43">getUsername</a>()</pre> |
| <div class="block">Returns the case insensitive substring user name criteria.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the username criteria.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUsername-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsername</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.50">setUsername</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName)</pre> |
| <div class="block">Sets the case insensitive substring user name criteria.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>userName</code> - the username criteria</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFullName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFullName</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.57">getFullName</a>()</pre> |
| <div class="block">Returns the case insensitive substring full name criteria.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the username criteria.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFullName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFullName</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.64">setFullName</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fullName)</pre> |
| <div class="block">Sets the case insensitive substring full name criteria.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fullName</code> - the full name criteria</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEmail--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEmail</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.71">getEmail</a>()</pre> |
| <div class="block">Returns the case insensitive substring email criteria.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the email criteria.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEmail-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEmail</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.78">setEmail</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)</pre> |
| <div class="block">Sets the case insensitive substring email criteria.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>email</code> - the email criteria</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFirstResult--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFirstResult</h4> |
| <pre>long <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.85">getFirstResult</a>()</pre> |
| <div class="block">Returns the index (zero based) of the first result to include. Useful for paging.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the first index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFirstResult-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFirstResult</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.92">setFirstResult</a>(int firstResult)</pre> |
| <div class="block">Sets the index (zero based) of the first result to include. Useful for paging.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>firstResult</code> - the first index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxResults--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxResults</h4> |
| <pre>long <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.99">getMaxResults</a>()</pre> |
| <div class="block">Returns the maximum number of users to return.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum number of users to return.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxResults-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxResults</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.106">setMaxResults</a>(int maxResults)</pre> |
| <div class="block">Sets the maximum number of users to return.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxResults</code> - the maximum number of users to return.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOrderBy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrderBy</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.114">getOrderBy</a>()</pre> |
| <div class="block">Returns the property used to order the results of this query. |
| This is one of <a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#ORDER_BY_USERNAME"><code>ORDER_BY_USERNAME</code></a>, <a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#ORDER_BY_FULLNAME"><code>ORDER_BY_FULLNAME</code></a> or <a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#ORDER_BY_EMAIL"><code>ORDER_BY_EMAIL</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the order property.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOrderBy-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOrderBy</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.122">setOrderBy</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> orderBy)</pre> |
| <div class="block">Sets the property used to order the results of this query. |
| This is one of <a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#ORDER_BY_USERNAME"><code>ORDER_BY_USERNAME</code></a>, <a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#ORDER_BY_FULLNAME"><code>ORDER_BY_FULLNAME</code></a> or <a href="../../../../../org/apache/archiva/redback/users/UserQuery.html#ORDER_BY_EMAIL"><code>ORDER_BY_EMAIL</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>orderBy</code> - the order property.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAscending--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAscending</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.129">isAscending</a>()</pre> |
| <div class="block">Returns true if the results should be returned in ascending order.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ascending</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAscending-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setAscending</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/archiva/redback/users/UserQuery.html#line.136">setAscending</a>(boolean ascending)</pre> |
| <div class="block">Set this to true if the results should be returned in ascending order.</div> |
| <dl> |
| <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> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/UserQuery.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"> |
| <li><a href="../../../../../org/apache/archiva/redback/users/UserNotFoundException.html" title="class in org.apache.archiva.redback.users"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/archiva/redback/users/UserQuery.html" target="_top">Frames</a></li> |
| <li><a href="UserQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
