Added: uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html?rev=1784198&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html (added) +++ uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html Thu Feb 23 19:30:22 2017 @@ -0,0 +1,458 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>DuccManagedReservationSubmit (Apache UIMA DUCC Java SDK 2.2.0 User-Level API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DuccManagedReservationSubmit (Apache UIMA DUCC Java SDK 2.2.0 \t\t\t\t\t\t\t\tUser-Level API Documentation)"; + } +//--> +</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="skip"><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/DuccManagedReservationSubmit.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/uima/ducc/cli/DuccManagedReservationCancel.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html" target="_top">Frames</a></li> +<li><a href="DuccManagedReservationSubmit.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="#fields_inherited_from_class_org.apache.uima.ducc.cli.CliBase">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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.uima.ducc.cli</div> +<h2 title="Class DuccManagedReservationSubmit" class="title">Class DuccManagedReservationSubmit</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">org.apache.uima.ducc.cli.CliBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.uima.ducc.cli.DuccManagedReservationSubmit</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.uima.ducc.cli.IUiOptions</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DuccManagedReservationSubmit</span> +extends <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></pre> +<div class="block">Submit a DUCC Managed Reservation. A Managed Reservation is a single arbitray process running + in a non-preemptable share.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.uima.ducc.cli.IUiOptions"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.uima.ducc.cli.IUiOptions</h3> +<code>org.apache.uima.ducc.cli.IUiOptions.UiOption</code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.uima.ducc.cli.CliBase"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.uima.ducc.cli.<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></h3> +<code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#cli_props">cli_props</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#commandLine">commandLine</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_attach">console_attach</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_listener">console_listener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleCb">consoleCb</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#debug">debug</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#dispatcher">dispatcher</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#ducc_home">ducc_home</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#errors">errors</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#friendlyId">friendlyId</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#host_address">host_address</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#messages">messages</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitor_listener">monitor_listener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#returnCode">returnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#suppress_console_log">suppress_console_log</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#userSpecifiedProperties">userSpecifiedProperties</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waiter">waiter</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#warnings">warnings</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.uima.ducc.cli.IUiOptions"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.uima.ducc.cli.IUiOptions</h3> +<code>help_width</code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.util.ArrayList)">DuccManagedReservationSubmit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.util.ArrayList,%20org.apache.uima.ducc.cli.IDuccCallback)">DuccManagedReservationSubmit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args, + <a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb)</code> +<div class="block">This form of the constructor allows the API user to capture + messages, rather than directing them to stdout.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.util.Properties)">DuccManagedReservationSubmit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.util.Properties,%20org.apache.uima.ducc.cli.IDuccCallback)">DuccManagedReservationSubmit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props, + <a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb)</code> +<div class="block">This form of the constructor allows the API user to capture + messages, rather than directing them to stdout.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.lang.String[])">DuccManagedReservationSubmit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.lang.String[],%20org.apache.uima.ducc.cli.IDuccCallback)">DuccManagedReservationSubmit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args, + <a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb)</code> +<div class="block">This form of the constructor allows the API user to capture + messages, rather than directing them to stdout.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#execute()">execute</a></strong>()</code> +<div class="block">Execute collects the job parameters, does basic error and correctness checking, and sends + the job properties to the DUCC orchestrator for execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#main(java.lang.String[])">main</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> +<div class="block">Main method, as used by the executable jar or direct java invocation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.uima.ducc.cli.CliBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.uima.ducc.cli.<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></h3> +<code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_heap_size(java.lang.String)">check_heap_size</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_service_dependencies(java.lang.String)">check_service_dependencies</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleExits()">consoleExits</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#extractReply(org.apache.uima.ducc.transport.event.AbstractDuccOrchestratorEvent)">extractReply</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getCallback()">getCallback</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getDuccId()">getDuccId</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getLogDirectory()">getLogDirectory</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getReturnCode()">getReturnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#inhibitDefaults()">inhibitDef aults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String,%20org.apache.uima.ducc.cli.IUiOption[],%20java.lang.String[],%20java.util.Properties,%20org.apache.uima.ducc.common.utils.DuccProperties,%20org.apache.uima.ducc.cli.IDuccCallback,%20java.lang.String)">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String,%20org.apache.uima.ducc.cli.IUiOptions.UiOption[],%20java.util.Properties,%20org.apache.uima.ducc.common.utils.DuccProperties,%20org.apache.uima.ducc.cli.IDuccCallback)">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String,%20org.apache.uima.ducc.cli.IUiOptions.UiOption[],%20java.lang.String[],%20org.apache.uima.ducc.common.utils.DuccProperties,%20org.apache.uima.ducc.cli.IDuccCallback)">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#initConsoleListener()">initConsoleListener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBa se.html#isConsoleAttached()">isConsoleAttached</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#message(java.lang.String...)">message</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitorExits(int)">monitorExits</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#saveSpec(java.lang.String,%20org.apache.uima.ducc.common.utils.DuccProperties)">saveSpec</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setDefaults(org.apache.uima.ducc.cli.IUiOption[],%20boolean)">setDefaults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setOptions(org.apache.uima.ducc.cli.IUiOption[])">setOptions</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setUser()">setUser</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setWorkingDirectory()">setWorkingDirec tory</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startConsoleListener(boolean)">startConsoleListener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitor(org.apache.uima.ducc.transport.event.IDuccContext.DuccContext)">startMonitor</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitors(boolean,%20org.apache.uima.ducc.transport.event.IDuccContext.DuccContext)">startMonitors</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#stopListeners()">stopListeners</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#usage(java.lang.String)">usage</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waitForCompletion()">waitForCompletion</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DuccManagedReservationSubmit(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DuccManagedReservationSubmit</h4> +<pre>public DuccManagedReservationSubmit(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - List of string arguments as described in the + <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +<a name="DuccManagedReservationSubmit(java.util.ArrayList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DuccManagedReservationSubmit</h4> +<pre>public DuccManagedReservationSubmit(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - Array of string arguments as described in the + <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +<a name="DuccManagedReservationSubmit(java.util.Properties)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DuccManagedReservationSubmit</h4> +<pre>public DuccManagedReservationSubmit(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - Properties file of arguments, as described in the + <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +<a name="DuccManagedReservationSubmit(java.lang.String[], org.apache.uima.ducc.cli.IDuccCallback)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DuccManagedReservationSubmit</h4> +<pre>public DuccManagedReservationSubmit(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args, + <a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">This form of the constructor allows the API user to capture + messages, rather than directing them to stdout.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - Array of string arguments as described in the + <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a></dd><dd><code>consoleCb</code> - If provided, messages are directed to it instead of + stdout.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +<a name="DuccManagedReservationSubmit(java.util.ArrayList, org.apache.uima.ducc.cli.IDuccCallback)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DuccManagedReservationSubmit</h4> +<pre>public DuccManagedReservationSubmit(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args, + <a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">This form of the constructor allows the API user to capture + messages, rather than directing them to stdout.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - List of string arguments as described in the + <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a></dd><dd><code>consoleCb</code> - If provided, messages are directed to it instead of + stdout.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +<a name="DuccManagedReservationSubmit(java.util.Properties, org.apache.uima.ducc.cli.IDuccCallback)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DuccManagedReservationSubmit</h4> +<pre>public DuccManagedReservationSubmit(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props, + <a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">This form of the constructor allows the API user to capture + messages, rather than directing them to stdout.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - Properties file contianing string arguments as described in the + <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a></dd><dd><code>consoleCb</code> - If provided, messages are directed to it instead of + stdout.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="execute()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public boolean execute() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Execute collects the job parameters, does basic error and correctness checking, and sends + the job properties to the DUCC orchestrator for execution.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#execute()">execute</a></code> in class <code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>True if the orchestrator accepts the job; false otherwise.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - The specific exception is a function of the implementor.</dd></dl> +</li> +</ul> +<a name="main(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre> +<div class="block">Main method, as used by the executable jar or direct java invocation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a></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="skip"><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/DuccManagedReservationSubmit.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/uima/ducc/cli/DuccManagedReservationCancel.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html" target="_top">Frames</a></li> +<li><a href="DuccManagedReservationSubmit.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="#fields_inherited_from_class_org.apache.uima.ducc.cli.CliBase">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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 © 2012–2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Propchange: uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html ------------------------------------------------------------------------------ svn:eol-style = native Added: uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/cli/DuccReservationCancel.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/cli/DuccReservationCancel.html?rev=1784198&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/cli/DuccReservationCancel.html (added) +++ uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/cli/DuccReservationCancel.html Thu Feb 23 19:30:22 2017 @@ -0,0 +1,466 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>DuccReservationCancel (Apache UIMA DUCC Java SDK 2.2.0 User-Level API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DuccReservationCancel (Apache UIMA DUCC Java SDK 2.2.0 \t\t\t\t\t\t\t\tUser-Level API Documentation)"; + } +//--> +</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="skip"><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/DuccReservationCancel.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/uima/ducc/cli/DuccManagedReservationSubmit.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/DuccReservationCancel.html" target="_top">Frames</a></li> +<li><a href="DuccReservationCancel.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><a href="#constructor_summary">Constr</a> | </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><a href="#constructor_detail">Constr</a> | </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.uima.ducc.cli</div> +<h2 title="Class DuccReservationCancel" class="title">Class DuccReservationCancel</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">org.apache.uima.ducc.cli.CliBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.uima.ducc.cli.DuccReservationCancel</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.uima.ducc.cli.IUiOptions</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DuccReservationCancel</span> +extends <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></pre> +<div class="block">Cancel a DUCC reservation</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.uima.ducc.cli.IUiOptions"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.uima.ducc.cli.IUiOptions</h3> +<code>org.apache.uima.ducc.cli.IUiOptions.UiOption</code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" 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>(package private) long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#canceledPid">canceledPid</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#opts">opts</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>(package private) org.apache.uima.ducc.transport.event.cli.ReservationRequestProperties</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#requestProperties">requestProperties</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>(package private) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#responseMessage">responseMessage</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.uima.ducc.cli.CliBase"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.uima.ducc.cli.<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></h3> +<code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#cli_props">cli_props</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#commandLine">commandLine</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_attach">console_attach</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_listener">console_listener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleCb">consoleCb</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#debug">debug</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#dispatcher">dispatcher</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#ducc_home">ducc_home</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#errors">errors</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#friendlyId">friendlyId</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#host_address">host_address</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#messages">messages</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitor_listener">monitor_listener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#returnCode">returnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#suppress_console_log">suppress_console_log</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#userSpecifiedProperties">userSpecifiedProperties</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waiter">waiter</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#warnings">warnings</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.uima.ducc.cli.IUiOptions"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.uima.ducc.cli.IUiOptions</h3> +<code>help_width</code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#DuccReservationCancel(java.util.List)">DuccReservationCancel</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#DuccReservationCancel(java.util.Properties)">DuccReservationCancel</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#DuccReservationCancel(java.lang.String[])">DuccReservationCancel</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#execute()">execute</a></strong>()</code> +<div class="block">Execute collects the parameters for reservation cancelation and sends them to the DUCC Orchestrator + to effect the cancelation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#getResponseMessage()">getResponseMessage</a></strong>()</code> +<div class="block">Return the DUCC Orchestrator message, if any, pertaining to the cancelation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html#main(java.lang.String[])">main</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> +<div class="block">Main method, as used by the executable jar or direct java invocation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.uima.ducc.cli.CliBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.uima.ducc.cli.<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></h3> +<code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_heap_size(java.lang.String)">check_heap_size</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_service_dependencies(java.lang.String)">check_service_dependencies</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleExits()">consoleExits</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#extractReply(org.apache.uima.ducc.transport.event.AbstractDuccOrchestratorEvent)">extractReply</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getCallback()">getCallback</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getDuccId()">getDuccId</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getLogDirectory()">getLogDirectory</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getReturnCode()">getReturnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#inhibitDefaults()">inhibitDef aults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String,%20org.apache.uima.ducc.cli.IUiOption[],%20java.lang.String[],%20java.util.Properties,%20org.apache.uima.ducc.common.utils.DuccProperties,%20org.apache.uima.ducc.cli.IDuccCallback,%20java.lang.String)">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String,%20org.apache.uima.ducc.cli.IUiOptions.UiOption[],%20java.util.Properties,%20org.apache.uima.ducc.common.utils.DuccProperties,%20org.apache.uima.ducc.cli.IDuccCallback)">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String,%20org.apache.uima.ducc.cli.IUiOptions.UiOption[],%20java.lang.String[],%20org.apache.uima.ducc.common.utils.DuccProperties,%20org.apache.uima.ducc.cli.IDuccCallback)">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#initConsoleListener()">initConsoleListener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBa se.html#isConsoleAttached()">isConsoleAttached</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#message(java.lang.String...)">message</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitorExits(int)">monitorExits</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#saveSpec(java.lang.String,%20org.apache.uima.ducc.common.utils.DuccProperties)">saveSpec</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setDefaults(org.apache.uima.ducc.cli.IUiOption[],%20boolean)">setDefaults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setOptions(org.apache.uima.ducc.cli.IUiOption[])">setOptions</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setUser()">setUser</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setWorkingDirectory()">setWorkingDirec tory</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startConsoleListener(boolean)">startConsoleListener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitor(org.apache.uima.ducc.transport.event.IDuccContext.DuccContext)">startMonitor</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitors(boolean,%20org.apache.uima.ducc.transport.event.IDuccContext.DuccContext)">startMonitors</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#stopListeners()">stopListeners</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#usage(java.lang.String)">usage</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waitForCompletion()">waitForCompletion</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</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="requestProperties"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requestProperties</h4> +<pre>org.apache.uima.ducc.transport.event.cli.ReservationRequestProperties requestProperties</pre> +</li> +</ul> +<a name="canceledPid"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canceledPid</h4> +<pre>long canceledPid</pre> +</li> +</ul> +<a name="responseMessage"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>responseMessage</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> responseMessage</pre> +</li> +</ul> +<a name="opts"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>opts</h4> +<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] opts</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DuccReservationCancel(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DuccReservationCancel</h4> +<pre>public DuccReservationCancel(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - Array of string arguments as described in the + <a href="/doc/duccbook.html#DUCC_CLI_UNRESERVE">DUCC CLI reference.</a></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +<a name="DuccReservationCancel(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DuccReservationCancel</h4> +<pre>public DuccReservationCancel(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - List of string arguments as described in the + <a href="/doc/duccbook.html#DUCC_CLI_UNRESERVE">DUCC CLI reference.</a></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +<a name="DuccReservationCancel(java.util.Properties)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DuccReservationCancel</h4> +<pre>public DuccReservationCancel(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - Properties file of arguments, as described in the + <a href="/doc/duccbook.html#DUCC_CLI_UNRESERVE">DUCC CLI reference.</a></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getResponseMessage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponseMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getResponseMessage()</pre> +<div class="block">Return the DUCC Orchestrator message, if any, pertaining to the cancelation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Return any message associated with the cancelation.</dd></dl> +</li> +</ul> +<a name="execute()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public boolean execute() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Execute collects the parameters for reservation cancelation and sends them to the DUCC Orchestrator + to effect the cancelation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#execute()">execute</a></code> in class <code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>True if the orchestrator accepts the reservation cancelation.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - The specific exception is a function of the implementor.</dd></dl> +</li> +</ul> +<a name="main(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre> +<div class="block">Main method, as used by the executable jar or direct java invocation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_UNRESERVE">DUCC CLI reference.</a></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="skip"><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/DuccReservationCancel.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/uima/ducc/cli/DuccManagedReservationSubmit.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/DuccReservationCancel.html" target="_top">Frames</a></li> +<li><a href="DuccReservationCancel.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><a href="#constructor_summary">Constr</a> | </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><a href="#constructor_detail">Constr</a> | </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 © 2012–2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Propchange: uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/org/apache/uima/ducc/cli/DuccReservationCancel.html ------------------------------------------------------------------------------ svn:eol-style = native