Changes between Initial Version and Version 1 of PloneSMS/ShortMessage/Products.ShortMessage.Extensions.Sm_Workflow-module.html


Ignore:
Timestamp:
Dec 23, 2005 2:55:24 PM (18 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PloneSMS/ShortMessage/Products.ShortMessage.Extensions.Sm_Workflow-module.html

    v1 v1  
     1= Products.ShortMessage.Extensions.Sm_Workflow = 
     2{{{ 
     3#!html 
     4 
     5 
     6<!-- =========== START OF NAVBAR =========== --> 
     7<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> 
     8  <tr valign="center"> 
     9    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="Products.ShortMessage-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th> 
     10    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th> 
     11    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th> 
     12    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th> 
     13    <th class="navbar" width="100%"></th> 
     14  </tr> 
     15</table> 
     16<table width="100%" cellpadding="0" cellspacing="0"> 
     17  <tr valign="top"> 
     18    <td width="100%"> 
     19      <font size="-1"><b class="breadcrumbs"> 
     20        Package&nbsp;Products :: 
     21        <a href="Products.ShortMessage-module.html">Package&nbsp;ShortMessage</a> :: 
     22        <a href="Products.ShortMessage.Extensions-module.html">Package&nbsp;Extensions</a> :: 
     23        Module&nbsp;Sm_Workflow 
     24      </b></font></br> 
     25    </td> 
     26    <td><table cellpadding="0" cellspacing="0"> 
     27      <tr><td align="right"></td></tr> 
     28    </table></td> 
     29</tr></table> 
     30 
     31<!-- =========== START OF MODULE DESCRIPTION =========== --> 
     32<h2 class="module">Module Products.ShortMessage.Extensions.Sm_Workflow</h2> 
     33 
     34<p>This is workflow for ShortMessage type that sends SMS upon object publishing. 
     35This module define the following functions:</p> 
     36<blockquote> 
     37<ul class="rst-simple"> 
     38<li><a href="Products.ShortMessage.Extensions.Sm_Workflow-module.html#createWorkflow" class="link"><code>createWorkflow</code></a>: create new workflow.</li> 
     39<li><a href="Products.ShortMessage.Extensions.Sm_Workflow-module.html#fillWorkflow" class="link"><code>fillWorkflow</code></a>: takes created workflow and add to it state, transitions, permissions and etc.</li> 
     40<li><a href="Products.ShortMessage.Extensions.Sm_Workflow-module.html#addWorkflowScripts" class="link"><code>addWorkflowScripts</code></a>: add ExternalMethod named send_publishedMessage to the workflow</li> 
     41<li><a href="Products.ShortMessage.Extensions.Sm_Workflow-module.html#setupWorkflow" class="link"><code>setupWorkflow</code></a>: setup created workflow to portal and set it to ShortMessage type</li> 
     42<li><a href="Products.ShortMessage.Extensions.Sm_Workflow-module.html#send_publishedMessage" class="link"><code>send_publishedMessage</code></a>: Send message if it is published</li> 
     43</ul> 
     44</blockquote> 
     45<hr/> 
     46 
     47<!-- =========== START OF FUNCTION SUMMARY =========== --> 
     48<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> 
     49<tr bgcolor="#70b0f0" class="summary"> 
     50  <th colspan="2">Function Summary</th></tr> 
     51<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
     52  <td><code><span class="summary-sig"><a href="Products.ShortMessage.Extensions.Sm_Workflow-module.html#addWorkflowScripts" class="summary-sig-name"><code>addWorkflowScripts</code></a>(<span class=summary-sig-arg>wf</span>)</span></code> 
     53<br /> 
     54add ExternalMethod named send_publishedMessage to the workflow</td></tr> 
     55<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
     56  <td><code><span class="summary-sig"><a href="Products.ShortMessage.Extensions.Sm_Workflow-module.html#createWorkflow" class="summary-sig-name"><code>createWorkflow</code></a>(<span class=summary-sig-arg>id</span>)</span></code> 
     57<br /> 
     58create new workflow</td></tr> 
     59<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
     60  <td><code><span class="summary-sig"><a href="Products.ShortMessage.Extensions.Sm_Workflow-module.html#fillWorkflow" class="summary-sig-name"><code>fillWorkflow</code></a>(<span class=summary-sig-arg>wf</span>)</span></code> 
     61<br /> 
     62takes created workflow and add to it state, transitions, permissions and etc</td></tr> 
     63<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
     64  <td><code><span class="summary-sig"><a href="Products.ShortMessage.Extensions.Sm_Workflow-module.html#send_publishedMessage" class="summary-sig-name"><code>send_publishedMessage</code></a>(<span class=summary-sig-arg>self</span>, 
     65          <span class=summary-sig-arg>state_change</span>)</span></code> 
     66<br /> 
     67Send message if it is published</td></tr> 
     68<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td> 
     69  <td><code><a name="setupWorkflow"></a><span class="summary-sig"><span class="summary-sig-name">setupWorkflow</span>(<span class=summary-sig-arg>portal</span>)</span></code> 
     70</td></tr> 
     71</table><br /> 
     72 
     73 
     74<!-- =========== START OF FUNCTION DETAILS =========== --> 
     75<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> 
     76<tr bgcolor="#70b0f0" class="details"> 
     77  <th colspan="2">Function Details</th></tr> 
     78</table> 
     79 
     80<a name="addWorkflowScripts"></a> 
     81<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> 
     82  <h3><span class="sig"><span class="sig-name">addWorkflowScripts</span>(<span class=sig-arg>wf</span>)</span> 
     83  </h3> 
     84<p>add ExternalMethod named send_publishedMessage to the workflow</p> 
     85  <dl><dt></dt><dd> 
     86  </dd></dl> 
     87</td></tr></table> 
     88 
     89<a name="createWorkflow"></a> 
     90<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> 
     91  <h3><span class="sig"><span class="sig-name">createWorkflow</span>(<span class=sig-arg>id</span>)</span> 
     92  </h3> 
     93<p>create new workflow</p> 
     94  <dl><dt></dt><dd> 
     95  </dd></dl> 
     96</td></tr></table> 
     97 
     98<a name="fillWorkflow"></a> 
     99<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> 
     100  <h3><span class="sig"><span class="sig-name">fillWorkflow</span>(<span class=sig-arg>wf</span>)</span> 
     101  </h3> 
     102<p>takes created workflow and add to it state, transitions, permissions and etc</p> 
     103  <dl><dt></dt><dd> 
     104  </dd></dl> 
     105</td></tr></table> 
     106 
     107<a name="send_publishedMessage"></a> 
     108<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> 
     109  <h3><span class="sig"><span class="sig-name">send_publishedMessage</span>(<span class=sig-arg>self</span>, 
     110          <span class=sig-arg>state_change</span>)</span> 
     111  </h3> 
     112<p>Send message if it is published</p> 
     113  <dl><dt></dt><dd> 
     114  </dd></dl> 
     115</td></tr></table> 
     116<br /> 
     117 
     118 
     119<!-- =========== START OF NAVBAR =========== --> 
     120<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> 
     121  <tr valign="center"> 
     122    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="Products.ShortMessage-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th> 
     123    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th> 
     124    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th> 
     125    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th> 
     126    <th class="navbar" width="100%"></th> 
     127  </tr> 
     128</table> 
     129 
     130<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
     131  <tr> 
     132    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Fri Dec 23 14:49:35 2005</font></td> 
     133    <td align="right"><a href="http://epydoc.sourceforge.net" 
     134                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
     135  </tr> 
     136</table> 
     137 
     138}}}