usher
Version:
Simple DSL for composing decision workflows for AWS Simple Workflow
554 lines (211 loc) • 8.47 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Usher Class: Workflow</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<a class="brand" href="index.html">Usher</a>
<ul class="nav">
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="Fragment.html">Fragment</a>
</li>
<li>
<a href="Usher.html">Usher</a>
</li>
<li>
<a href="Workflow.html">Workflow</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: Workflow</h1>
<section>
<header>
<h2>
Workflow
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Workflow"><span class="type-signature"></span>new Workflow<span class="signature">(name, domain, <span class="optional">tasklist</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Represents a single, named workflow, where all activities and decisions are defined.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">The name of the workflow.</td>
</tr>
<tr>
<td class="name"><code>domain</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">The AWS SWF domain name to execute this workflow in.</td>
</tr>
<tr>
<td class="name"><code>tasklist</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<name>-tasklist
</td>
<td class="description last">The name of the tasklist to listen for tasks on.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="workflow.js.html">workflow.js</a>, <a href="workflow.js.html#sunlight-1-line-29">line 29</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="start"><span class="type-signature"></span>start<span class="signature">()</span><span class="type-signature"> → {<a href="Workflow.html">Workflow</a>}</span></h4>
</dt>
<dd>
<div class="description">
Start listening for decision tasks from SWF
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="workflow.js.html">workflow.js</a>, <a href="workflow.js.html#sunlight-1-line-53">line 53</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
This workflow so you can chain commands.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Workflow.html">Workflow</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">()</span><span class="type-signature"> → {<a href="Workflow.html">Workflow</a>}</span></h4>
</dt>
<dd>
<div class="description">
Stop listening for decision tasks from SWF
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="workflow.js.html">workflow.js</a>, <a href="workflow.js.html#sunlight-1-line-93">line 93</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
This workflow so you can chain commands.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Workflow.html">Workflow</a></span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Copyright (C) 2014 meltmedia
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a>
on Mon Jun 23 2014 14:32:21 GMT-0700 (MST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>