website/docs/full_javadoc/compbio/metadata/JobStatus.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:32:49 BST 2017 -->
   6 <title>JobStatus</title>
   7 <meta name="date" content="2017-04-21">
   8 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
   9 <script type="text/javascript" src="../../script.js"></script>
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     try {
  14         if (location.href.indexOf('is-external=true') == -1) {
  15             parent.document.title="JobStatus";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":9,"i1":9};
  22 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
  23 var altColor = "altColor";
  24 var rowColor = "rowColor";
  25 var tableTab = "tableTab";
  26 var activeTableTab = "activeTableTab";
  27 </script>
  28 <noscript>
  29 <div>JavaScript is disabled on your browser.</div>
  30 </noscript>
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <div class="topNav"><a name="navbar.top">
  33 <!--   -->
  34 </a>
  35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36 <a name="navbar.top.firstrow">
  37 <!--   -->
  38 </a>
  39 <ul class="navList" title="Navigation">
  40 <li><a href="../../overview-summary.html">Overview</a></li>
  41 <li><a href="package-summary.html">Package</a></li>
  42 <li class="navBarCell1Rev">Class</li>
  43 <li><a href="class-use/JobStatus.html">Use</a></li>
  44 <li><a href="package-tree.html">Tree</a></li>
  45 <li><a href="../../deprecated-list.html">Deprecated</a></li>
  46 <li><a href="../../index-files/index-1.html">Index</a></li>
  47 <li><a href="../../help-doc.html">Help</a></li>
  48 </ul>
  49 </div>
  50 <div class="subNav">
  51 <ul class="navList">
  52 <li><a href="../../compbio/metadata/JobExecutionException.html" title="class in compbio.metadata"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53 <li><a href="../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54 </ul>
  55 <ul class="navList">
  56 <li><a href="../../index.html?compbio/metadata/JobStatus.html" target="_top">Frames</a></li>
  57 <li><a href="JobStatus.html" target="_top">No&nbsp;Frames</a></li>
  58 </ul>
  59 <ul class="navList" id="allclasses_navbar_top">
  60 <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61 </ul>
  62 <div>
  63 <script type="text/javascript"><!--
  64   allClassesLink = document.getElementById("allclasses_navbar_top");
  65   if(window==top) {
  66     allClassesLink.style.display = "block";
  67   }
  68   else {
  69     allClassesLink.style.display = "none";
  70   }
  71   //-->
  72 </script>
  73 </div>
  74 <div>
  75 <ul class="subNavList">
  76 <li>Summary:&nbsp;</li>
  77 <li>Nested&nbsp;|&nbsp;</li>
  78 <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
  79 <li>Field&nbsp;|&nbsp;</li>
  80 <li><a href="#method.summary">Method</a></li>
  81 </ul>
  82 <ul class="subNavList">
  83 <li>Detail:&nbsp;</li>
  84 <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
  85 <li>Field&nbsp;|&nbsp;</li>
  86 <li><a href="#method.detail">Method</a></li>
  87 </ul>
  88 </div>
  89 <a name="skip.navbar.top">
  90 <!--   -->
  91 </a></div>
  92 <!-- ========= END OF TOP NAVBAR ========= -->
  93 <!-- ======== START OF CLASS DATA ======== -->
  94 <div class="header">
  95 <div class="subTitle">compbio.metadata</div>
  96 <h2 title="Enum JobStatus" class="title">Enum JobStatus</h2>
  97 </div>
  98 <div class="contentContainer">
  99 <ul class="inheritance">
 100 <li>java.lang.Object</li>
 101 <li>
 102 <ul class="inheritance">
 103 <li>java.lang.Enum&lt;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a>&gt;</li>
 104 <li>
 105 <ul class="inheritance">
 106 <li>compbio.metadata.JobStatus</li>
 107 </ul>
 108 </li>
 109 </ul>
 110 </li>
 111 </ul>
 112 <div class="description">
 113 <ul class="blockList">
 114 <li class="blockList">
 115 <dl>
 116 <dt>All Implemented Interfaces:</dt>
 117 <dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a>&gt;</dd>
 118 </dl>
 119 <hr>
 120 <br>
 121 <pre>public enum <span class="typeNameLabel">JobStatus</span>
 122 extends java.lang.Enum&lt;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a>&gt;</pre>
 123 <div class="block">The status of the job.</div>
 124 <dl>
 125 <dt><span class="simpleTagLabel">Version:</span></dt>
 126 <dd>1.0 October 2009</dd>
 127 <dt><span class="simpleTagLabel">Author:</span></dt>
 128 <dd>pvtroshin</dd>
 129 </dl>
 130 </li>
 131 </ul>
 132 </div>
 133 <div class="summary">
 134 <ul class="blockList">
 135 <li class="blockList">
 136 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
 137 <ul class="blockList">
 138 <li class="blockList"><a name="enum.constant.summary">
 139 <!--   -->
 140 </a>
 141 <h3>Enum Constant Summary</h3>
 142 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
 143 <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
 144 <tr>
 145 <th class="colOne" scope="col">Enum Constant and Description</th>
 146 </tr>
 147 <tr class="altColor">
 148 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#CANCELLED">CANCELLED</a></span></code>
 149 <div class="block">Jobs that has been cancelled</div>
 150 </td>
 151 </tr>
 152 <tr class="rowColor">
 153 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#COLLECTED">COLLECTED</a></span></code>
 154 <div class="block">Results has been collected</div>
 155 </td>
 156 </tr>
 157 <tr class="altColor">
 158 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#FAILED">FAILED</a></span></code>
 159 <div class="block">Failed jobs</div>
 160 </td>
 161 </tr>
 162 <tr class="rowColor">
 163 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#FINISHED">FINISHED</a></span></code>
 164 <div class="block">Finished jobs</div>
 165 </td>
 166 </tr>
 167 <tr class="altColor">
 168 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#PENDING">PENDING</a></span></code>
 169 <div class="block">Jobs which are in the queue and awaiting execution reported for cluster
 170  jobs only</div>
 171 </td>
 172 </tr>
 173 <tr class="rowColor">
 174 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#RUNNING">RUNNING</a></span></code>
 175 <div class="block">Jobs that are running</div>
 176 </td>
 177 </tr>
 178 <tr class="altColor">
 179 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#STARTED">STARTED</a></span></code>
 180 <div class="block">Job calculation has been started.</div>
 181 </td>
 182 </tr>
 183 <tr class="rowColor">
 184 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#SUBMITTED">SUBMITTED</a></span></code>
 185 <div class="block">Job has been submitted.</div>
 186 </td>
 187 </tr>
 188 <tr class="altColor">
 189 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#UNDEFINED">UNDEFINED</a></span></code>
 190 <div class="block">Represents jobs with unknown status</div>
 191 </td>
 192 </tr>
 193 </table>
 194 </li>
 195 </ul>
 196 <!-- ========== METHOD SUMMARY =========== -->
 197 <ul class="blockList">
 198 <li class="blockList"><a name="method.summary">
 199 <!--   -->
 200 </a>
 201 <h3>Method Summary</h3>
 202 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 203 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>
 204 <tr>
 205 <th class="colFirst" scope="col">Modifier and Type</th>
 206 <th class="colLast" scope="col">Method and Description</th>
 207 </tr>
 208 <tr id="i0" class="altColor">
 209 <td class="colFirst"><code>static <a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a></code></td>
 210 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
 211 <div class="block">Returns the enum constant of this type with the specified name.</div>
 212 </td>
 213 </tr>
 214 <tr id="i1" class="rowColor">
 215 <td class="colFirst"><code>static <a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a>[]</code></td>
 216 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/JobStatus.html#values--">values</a></span>()</code>
 217 <div class="block">Returns an array containing the constants of this enum type, in
 218 the order they are declared.</div>
 219 </td>
 220 </tr>
 221 </table>
 222 <ul class="blockList">
 223 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
 224 <!--   -->
 225 </a>
 226 <h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
 227 <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
 228 </ul>
 229 <ul class="blockList">
 230 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 231 <!--   -->
 232 </a>
 233 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 234 <code>getClass, notify, notifyAll, wait, wait, wait</code></li>
 235 </ul>
 236 </li>
 237 </ul>
 238 </li>
 239 </ul>
 240 </div>
 241 <div class="details">
 242 <ul class="blockList">
 243 <li class="blockList">
 244 <!-- ============ ENUM CONSTANT DETAIL =========== -->
 245 <ul class="blockList">
 246 <li class="blockList"><a name="enum.constant.detail">
 247 <!--   -->
 248 </a>
 249 <h3>Enum Constant Detail</h3>
 250 <a name="PENDING">
 251 <!--   -->
 252 </a>
 253 <ul class="blockList">
 254 <li class="blockList">
 255 <h4>PENDING</h4>
 256 <pre>public static final&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a> PENDING</pre>
 257 <div class="block">Jobs which are in the queue and awaiting execution reported for cluster
 258  jobs only</div>
 259 </li>
 260 </ul>
 261 <a name="RUNNING">
 262 <!--   -->
 263 </a>
 264 <ul class="blockList">
 265 <li class="blockList">
 266 <h4>RUNNING</h4>
 267 <pre>public static final&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a> RUNNING</pre>
 268 <div class="block">Jobs that are running</div>
 269 </li>
 270 </ul>
 271 <a name="CANCELLED">
 272 <!--   -->
 273 </a>
 274 <ul class="blockList">
 275 <li class="blockList">
 276 <h4>CANCELLED</h4>
 277 <pre>public static final&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a> CANCELLED</pre>
 278 <div class="block">Jobs that has been cancelled</div>
 279 </li>
 280 </ul>
 281 <a name="FINISHED">
 282 <!--   -->
 283 </a>
 284 <ul class="blockList">
 285 <li class="blockList">
 286 <h4>FINISHED</h4>
 287 <pre>public static final&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a> FINISHED</pre>
 288 <div class="block">Finished jobs</div>
 289 </li>
 290 </ul>
 291 <a name="FAILED">
 292 <!--   -->
 293 </a>
 294 <ul class="blockList">
 295 <li class="blockList">
 296 <h4>FAILED</h4>
 297 <pre>public static final&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a> FAILED</pre>
 298 <div class="block">Failed jobs</div>
 299 </li>
 300 </ul>
 301 <a name="UNDEFINED">
 302 <!--   -->
 303 </a>
 304 <ul class="blockList">
 305 <li class="blockList">
 306 <h4>UNDEFINED</h4>
 307 <pre>public static final&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a> UNDEFINED</pre>
 308 <div class="block">Represents jobs with unknown status</div>
 309 </li>
 310 </ul>
 311 <a name="STARTED">
 312 <!--   -->
 313 </a>
 314 <ul class="blockList">
 315 <li class="blockList">
 316 <h4>STARTED</h4>
 317 <pre>public static final&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a> STARTED</pre>
 318 <div class="block">Job calculation has been started. First status reported by the local
 319  engine</div>
 320 </li>
 321 </ul>
 322 <a name="SUBMITTED">
 323 <!--   -->
 324 </a>
 325 <ul class="blockList">
 326 <li class="blockList">
 327 <h4>SUBMITTED</h4>
 328 <pre>public static final&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a> SUBMITTED</pre>
 329 <div class="block">Job has been submitted. This status is only set for cluster jobs</div>
 330 </li>
 331 </ul>
 332 <a name="COLLECTED">
 333 <!--   -->
 334 </a>
 335 <ul class="blockListLast">
 336 <li class="blockList">
 337 <h4>COLLECTED</h4>
 338 <pre>public static final&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a> COLLECTED</pre>
 339 <div class="block">Results has been collected</div>
 340 </li>
 341 </ul>
 342 </li>
 343 </ul>
 344 <!-- ============ METHOD DETAIL ========== -->
 345 <ul class="blockList">
 346 <li class="blockList"><a name="method.detail">
 347 <!--   -->
 348 </a>
 349 <h3>Method Detail</h3>
 350 <a name="values--">
 351 <!--   -->
 352 </a>
 353 <ul class="blockList">
 354 <li class="blockList">
 355 <h4>values</h4>
 356 <pre>public static&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a>[]&nbsp;values()</pre>
 357 <div class="block">Returns an array containing the constants of this enum type, in
 358 the order they are declared.  This method may be used to iterate
 359 over the constants as follows:
 360 <pre>
 361 for (JobStatus c : JobStatus.values())
 362 &nbsp;   System.out.println(c);
 363 </pre></div>
 364 <dl>
 365 <dt><span class="returnLabel">Returns:</span></dt>
 366 <dd>an array containing the constants of this enum type, in the order they are declared</dd>
 367 </dl>
 368 </li>
 369 </ul>
 370 <a name="valueOf-java.lang.String-">
 371 <!--   -->
 372 </a>
 373 <ul class="blockListLast">
 374 <li class="blockList">
 375 <h4>valueOf</h4>
 376 <pre>public static&nbsp;<a href="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
 377 <div class="block">Returns the enum constant of this type with the specified name.
 378 The string must match <i>exactly</i> an identifier used to declare an
 379 enum constant in this type.  (Extraneous whitespace characters are
 380 not permitted.)</div>
 381 <dl>
 382 <dt><span class="paramLabel">Parameters:</span></dt>
 383 <dd><code>name</code> - the name of the enum constant to be returned.</dd>
 384 <dt><span class="returnLabel">Returns:</span></dt>
 385 <dd>the enum constant with the specified name</dd>
 386 <dt><span class="throwsLabel">Throws:</span></dt>
 387 <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
 388 <dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
 389 </dl>
 390 </li>
 391 </ul>
 392 </li>
 393 </ul>
 394 </li>
 395 </ul>
 396 </div>
 397 </div>
 398 <!-- ========= END OF CLASS DATA ========= -->
 399 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 400 <div class="bottomNav"><a name="navbar.bottom">
 401 <!--   -->
 402 </a>
 403 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 404 <a name="navbar.bottom.firstrow">
 405 <!--   -->
 406 </a>
 407 <ul class="navList" title="Navigation">
 408 <li><a href="../../overview-summary.html">Overview</a></li>
 409 <li><a href="package-summary.html">Package</a></li>
 410 <li class="navBarCell1Rev">Class</li>
 411 <li><a href="class-use/JobStatus.html">Use</a></li>
 412 <li><a href="package-tree.html">Tree</a></li>
 413 <li><a href="../../deprecated-list.html">Deprecated</a></li>
 414 <li><a href="../../index-files/index-1.html">Index</a></li>
 415 <li><a href="../../help-doc.html">Help</a></li>
 416 </ul>
 417 </div>
 418 <div class="subNav">
 419 <ul class="navList">
 420 <li><a href="../../compbio/metadata/JobExecutionException.html" title="class in compbio.metadata"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 421 <li><a href="../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 422 </ul>
 423 <ul class="navList">
 424 <li><a href="../../index.html?compbio/metadata/JobStatus.html" target="_top">Frames</a></li>
 425 <li><a href="JobStatus.html" target="_top">No&nbsp;Frames</a></li>
 426 </ul>
 427 <ul class="navList" id="allclasses_navbar_bottom">
 428 <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 429 </ul>
 430 <div>
 431 <script type="text/javascript"><!--
 432   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 433   if(window==top) {
 434     allClassesLink.style.display = "block";
 435   }
 436   else {
 437     allClassesLink.style.display = "none";
 438   }
 439   //-->
 440 </script>
 441 </div>
 442 <div>
 443 <ul class="subNavList">
 444 <li>Summary:&nbsp;</li>
 445 <li>Nested&nbsp;|&nbsp;</li>
 446 <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
 447 <li>Field&nbsp;|&nbsp;</li>
 448 <li><a href="#method.summary">Method</a></li>
 449 </ul>
 450 <ul class="subNavList">
 451 <li>Detail:&nbsp;</li>
 452 <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
 453 <li>Field&nbsp;|&nbsp;</li>
 454 <li><a href="#method.detail">Method</a></li>
 455 </ul>
 456 </div>
 457 <a name="skip.navbar.bottom">
 458 <!--   -->
 459 </a></div>
 460 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 461 </body>
 462 </html>