<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (16) --> <title>CommonQueries (api 5.4-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="description" content="declaration: package: com.djrapitops.plan.query, interface: CommonQueries"> <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 evenRowColor = "even-row-color"; var oddRowColor = "odd-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="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>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li>Field | </li> <li>Constr | </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.djrapitops.plan.query</a></div> <h1 title="Interface CommonQueries" class="title">Interface CommonQueries</h1> </div> <section class="description"> <hr> <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">CommonQueries</span></div> <div class="block">Class that allows performing most commonly wanted queries. <p> This exists so that SQL does not necessarily need to be written. Obtain an instance from <a href="QueryService.html" title="interface in com.djrapitops.plan.query"><code>QueryService</code></a>.</div> </section> <section class="summary"> <ul class="summary-list"> <!-- ========== METHOD SUMMARY =========== --> <li> <section class="method-summary" id="method.summary"> <h2>Method Summary</h2> <div id="method-summary-table"> <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> <div id="method-summary-table.tabpanel" role="tabpanel"> <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> <div class="table-header col-first">Modifier and Type</div> <div class="table-header col-second">Method</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>boolean</code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#doesDBHaveTable(java.lang.String)">doesDBHaveTable</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> table)</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>boolean</code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#doesDBHaveTableColumn(java.lang.String,java.lang.String)">doesDBHaveTableColumn</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> table, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> column)</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> </div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>double</code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#fetchActivityIndexOf(java.util.UUID,long)">fetchActivityIndexOf</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID, long epochMs)</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> <div class="block">Calculates the activity index for the player at a specific date.</div> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#fetchCurrentSessionPlaytime(java.util.UUID)">fetchCurrentSessionPlaytime</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID)</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> <div class="block">Get playtime of current online session.</div> </div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#fetchLastSeen(java.util.UUID,java.util.UUID)">fetchLastSeen</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> serverUUID)</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> <div class="block">Fetch last seen Epoch ms for a player on a server.</div> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#fetchNameOf(java.util.UUID)">fetchNameOf</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID)</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> </div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#fetchPlaytime(java.util.UUID,java.util.UUID,long,long)">fetchPlaytime</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> serverUUID, long after, long before)</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> <div class="block">Fetch playtime of a player on a server.</div> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>></code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#fetchServerUUIDs()">fetchServerUUIDs</a></span>()</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> </div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>></code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#fetchUUIDOf(java.lang.String)">fetchUUIDOf</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> playerName)</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getActivityGroupForIndex(double)">getActivityGroupForIndex</a></span>​(double activityIndex)</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> <div class="block">Get a String that represents the Activity group for an index.</div> </div> </div> </div> </div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ============ METHOD DETAIL ========== --> <li> <section class="method-details" id="method.detail"> <h2>Method Details</h2> <ul class="member-list"> <li> <section class="detail" id="fetchPlaytime(java.util.UUID,java.util.UUID,long,long)"> <h3>fetchPlaytime</h3> <div class="member-signature"><span class="return-type">long</span> <span class="element-name">fetchPlaytime</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> serverUUID, long after, long before)</span></div> <div class="block">Fetch playtime of a player on a server. <p> Returns 0 for any non existing players or servers.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>playerUUID</code> - UUID of the player.</dd> <dd><code>serverUUID</code> - UUID of the Plan server.</dd> <dd><code>after</code> - Data after this Epoch ms should be fetched</dd> <dd><code>before</code> - Data before this Epoch ms should be fetched</dd> <dt>Returns:</dt> <dd>Milliseconds the player has played with the defined parameters.</dd> </dl> </section> </li> <li> <section class="detail" id="fetchCurrentSessionPlaytime(java.util.UUID)"> <h3>fetchCurrentSessionPlaytime</h3> <div class="member-signature"><span class="return-type">long</span> <span class="element-name">fetchCurrentSessionPlaytime</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID)</span></div> <div class="block">Get playtime of current online session. <p> Requires Capability QUERY_API_ACTIVE_SESSION_PLAYTIME</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>playerUUID</code> - UUID of the player.</dd> <dt>Returns:</dt> <dd>Milliseconds the player has played during current online session. 0 if player is offline.</dd> </dl> </section> </li> <li> <section class="detail" id="fetchLastSeen(java.util.UUID,java.util.UUID)"> <h3>fetchLastSeen</h3> <div class="member-signature"><span class="return-type">long</span> <span class="element-name">fetchLastSeen</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> serverUUID)</span></div> <div class="block">Fetch last seen Epoch ms for a player on a server.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>playerUUID</code> - UUID of the player.</dd> <dd><code>serverUUID</code> - UUID of the Plan server.</dd> <dt>Returns:</dt> <dd>Epoch ms the player was last seen, 0 if player has not played on server.</dd> </dl> </section> </li> <li> <section class="detail" id="fetchServerUUIDs()"> <h3>fetchServerUUIDs</h3> <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>></span> <span class="element-name">fetchServerUUIDs</span>()</div> </section> </li> <li> <section class="detail" id="fetchUUIDOf(java.lang.String)"> <h3>fetchUUIDOf</h3> <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>></span> <span class="element-name">fetchUUIDOf</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> playerName)</span></div> </section> </li> <li> <section class="detail" id="fetchNameOf(java.util.UUID)"> <h3>fetchNameOf</h3> <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">fetchNameOf</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID)</span></div> </section> </li> <li> <section class="detail" id="doesDBHaveTable(java.lang.String)"> <h3>doesDBHaveTable</h3> <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">doesDBHaveTable</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> table)</span></div> </section> </li> <li> <section class="detail" id="doesDBHaveTableColumn(java.lang.String,java.lang.String)"> <h3>doesDBHaveTableColumn</h3> <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">doesDBHaveTableColumn</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> table, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> column)</span></div> </section> </li> <li> <section class="detail" id="fetchActivityIndexOf(java.util.UUID,long)"> <h3>fetchActivityIndexOf</h3> <div class="member-signature"><span class="return-type">double</span> <span class="element-name">fetchActivityIndexOf</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID, long epochMs)</span></div> <div class="block">Calculates the activity index for the player at a specific date.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>playerUUID</code> - UUID of the player.</dd> <dd><code>epochMs</code> - Epoch millisecond to use for calculation</dd> <dt>Returns:</dt> <dd>a double between 0.0 and 5.0.</dd> </dl> </section> </li> <li> <section class="detail" id="getActivityGroupForIndex(double)"> <h3>getActivityGroupForIndex</h3> <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getActivityGroupForIndex</span>​<span class="parameters">(double activityIndex)</span></div> <div class="block">Get a String that represents the Activity group for an index.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>activityIndex</code> - a double between 0.0 and 5.0.</dd> <dt>Returns:</dt> <dd>Name of the group (in English) that this activityIndex falls within.</dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>