blob: f23727b6516f9490b49c1c0acbcdf99404e84579 [file] [log] [blame]
<!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 (1.8.0_161) on Thu Nov 28 14:41:31 PST 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NCResult (NLPCraft Java Client 0.4.0)</title>
<meta name="date" content="2019-11-28">
<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="NCResult (NLPCraft Java Client 0.4.0)";
}
}
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};
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>
<link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"> <script src="../../../resources/sh/scripts/XRegExp.js" type="text/javascript"></script> <script src="../../../resources/sh/scripts/shCore.js" type="text/javascript"></script> <script src="../../../resources/sh/scripts/shAutoloader.js" type="text/javascript"></script> <link href="../../../resources/sh/styles/shCoreDataLingvo.css" rel="stylesheet" type="text/css" title="Style"> <link href="../../../resources/sh/styles/shThemeDataLingvo.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet"> <script async defer src="https://buttons.github.io/buttons.js"></script>
<!-- ========= 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="../../../org/nlpcraft/client/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NCResult.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 class="aboutLanguage">NLPCraft Java Client 0.4.0</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/nlpcraft/client/NCProbe.html" title="interface in org.nlpcraft.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/nlpcraft/client/NCUser.html" title="interface in org.nlpcraft.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/nlpcraft/client/NCResult.html" target="_top">Frames</a></li>
<li><a href="NCResult.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.nlpcraft.client</div>
<h2 title="Interface NCResult" class="title">Interface NCResult</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">NCResult</span></pre>
<div class="block">Request result descriptor.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/nlpcraft/client/NCClient.html#askSync-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.Long-java.lang.String-"><code>NCClient.askSync(String, String, String, boolean, Long, String)</code></a>,
<a href="../../../org/nlpcraft/client/NCClient.html#askSync-java.lang.String-java.lang.String-"><code>NCClient.askSync(String, String)</code></a>,
<a href="../../../org/nlpcraft/client/NCClient.html#check-java.util.Set-java.lang.Integer-java.lang.Long-java.lang.String-"><code>NCClient.check(Set, Integer, Long, String)</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCResult.html#getErrorCode--">getErrorCode</a></span>()</code>
<div class="block">Gets optional error code.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://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/nlpcraft/client/NCResult.html#getErrorMessage--">getErrorMessage</a></span>()</code>
<div class="block">Gets optional error message.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://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/nlpcraft/client/NCResult.html#getLogHolder--">getLogHolder</a></span>()</code>
<div class="block">Gets optional processing log holder.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://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/nlpcraft/client/NCResult.html#getModelId--">getModelId</a></span>()</code>
<div class="block">Gets ID of the model that request was submitted with.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://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/nlpcraft/client/NCResult.html#getProbeId--">getProbeId</a></span>()</code>
<div class="block">Gets ID of the probe the request was processed by.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://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/nlpcraft/client/NCResult.html#getResultBody--">getResultBody</a></span>()</code>
<div class="block">Gets the result body as stringified JSON object.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://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/nlpcraft/client/NCResult.html#getResultType--">getResultType</a></span>()</code>
<div class="block">Gets the result type.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://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/nlpcraft/client/NCResult.html#getServerRequestId--">getServerRequestId</a></span>()</code>
<div class="block">Gets ID of the server request ID.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="http://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/nlpcraft/client/NCResult.html#getText--">getText</a></span>()</code>
<div class="block">Gets the original text of the request.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCResult.html#getUserId--">getUserId</a></span>()</code>
<div class="block">Gets ID of the user submitted the request.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCResult.html#isReady--">isReady</a></span>()</code>
<div class="block">Gets ready status of the request.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getServerRequestId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerRequestId</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getServerRequestId()</pre>
<div class="block">Gets ID of the server request ID.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID of the server request ID.</dd>
</dl>
</li>
</ul>
<a name="getText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getText</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getText()</pre>
<div class="block">Gets the original text of the request.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Original text of the request.</dd>
</dl>
</li>
</ul>
<a name="getUserId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserId</h4>
<pre>long&nbsp;getUserId()</pre>
<div class="block">Gets ID of the user submitted the request. In other words, this is ID of the user on behalf of which
the request was submitted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID of the user submitted the request.</dd>
</dl>
</li>
</ul>
<a name="getModelId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModelId</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getModelId()</pre>
<div class="block">Gets ID of the model that request was submitted with.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID of the model that request was submitted with.</dd>
</dl>
</li>
</ul>
<a name="getProbeId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProbeId</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getProbeId()</pre>
<div class="block">Gets ID of the probe the request was processed by.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID of the probe the request was processed by.</dd>
</dl>
</li>
</ul>
<a name="isReady--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReady</h4>
<pre>boolean&nbsp;isReady()</pre>
<div class="block">Gets ready status of the request. Note that results obtained from <a href="../../../org/nlpcraft/client/NCClient.html#check-java.util.Set-java.lang.Integer-java.lang.Long-java.lang.String-"><code>NCClient.check(Set, Integer, Long, String)</code></a>
method can be in not-ready state indicating that they are submitted but still being processed. Results returned
from <a href="../../../org/nlpcraft/client/NCClient.html#askSync-java.lang.String-java.lang.String-"><code>NCClient.askSync(String, String)</code></a> or <a href="../../../org/nlpcraft/client/NCClient.html#askSync-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.Long-java.lang.String-"><code>NCClient.askSync(String, String, String, boolean, Long, String)</code></a>
methods are always ready.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Ready status of the request.</dd>
</dl>
</li>
</ul>
<a name="getResultType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultType</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getResultType()</pre>
<div class="block">Gets the result type. See <code>NCQueryResult</code> class for details.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Query result type.</dd>
</dl>
</li>
</ul>
<a name="getResultBody--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultBody</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getResultBody()</pre>
<div class="block">Gets the result body as stringified JSON object. See <code>NCQueryResult</code> class for details.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Query result body.</dd>
</dl>
</li>
</ul>
<a name="getErrorCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorCode</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;getErrorCode()</pre>
<div class="block">Gets optional error code. See <code>/check</code> operation in
<a href="https://github.com/nlpcrafters/nlpcraft/blob/master/openapi/nlpcraft_swagger.yml" target=_>openapi/nlpcraft_swagger.yml</a> file
for more details. Note that error code and error message are only present if query result is unsuccessful.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Optional error code. Can be <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getErrorMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorMessage</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getErrorMessage()</pre>
<div class="block">Gets optional error message. Note that error code and error message are only present if query
result is unsuccessful.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Optional error message. Can be <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getLogHolder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLogHolder</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getLogHolder()</pre>
<div class="block">Gets optional processing log holder. When not <code>null</code> this string contains JSON object representing
processing log.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Optional processing log. Can be <code>null</code>.</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="../../../org/nlpcraft/client/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NCResult.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 class="aboutLanguage"><span style="vertical-align: super">NLPCraft Java Client 0.4.0</span> <a style="vertical-align: super; margin-right: 10px" href="https://github.com/nlpcrafters/nlpcraft-java-client " target="github"><i class="fa fa-github github-logo"></i></a> <a class="github-button" href="https://github.com/nlpcrafters/nlpcraft-java-client/subscription" data-icon="octicon-eye" aria-label="Watch nlpcrafters/nlpcraft-java-client on GitHub">Watch</a> <a class="github-button" href="https://github.com/nlpcrafters/nlpcraft-java-client" data-icon="octicon-star" aria-label="Star nlpcrafters/nlpcraft-java-client on GitHub">Star</a> <a class="github-button" href="https://github.com/nlpcrafters/nlpcraft-java-client/fork" data-icon="octicon-repo-forked" aria-label="Fork nlpcrafters/nlpcraft-java-client on GitHub">Fork</a> <script type="text/javascript"> SyntaxHighlighter.defaults["auto-links"] = false; SyntaxHighlighter.defaults["tab-size"] = 2; SyntaxHighlighter.autoloader( 'java ../../../resources/sh/scripts/shBrushJava.js', 'js jscript javascript ../../../resources/sh/scripts/shBrushJScript.js', 'text plain ../../../resources/sh/scripts/shBrushPlain.js', 'py python ../../../resources/sh/scripts/shBrushPython.js', 'ruby rails ror rb ../../../resources/sh/scripts/shBrushRuby.js', 'scala ../../../resources/sh/scripts/shBrushScala.js', 'sql ../../../resources/sh/scripts/shBrushSql.js', 'xml xhtml xslt html ../../../resources/sh/scripts/shBrushXml.js' ); SyntaxHighlighter.all(); </script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/nlpcraft/client/NCProbe.html" title="interface in org.nlpcraft.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/nlpcraft/client/NCUser.html" title="interface in org.nlpcraft.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/nlpcraft/client/NCResult.html" target="_top">Frames</a></li>
<li><a href="NCResult.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.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>
</div>
<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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2019 NLPCraft Project. All rights reserved.</small></p>
</body>
</html>