https://sourceforge.net/p/coils/wiki/LogicCommand/Recent changes to LogicCommandenSat, 27 Apr 2013 13:04:22 -0000https://sourceforge.net/p/coils/wiki/LogicCommand/<div class="markdown_content"><pre>--- v1 +++ v2 @@ -17,7 +17,17 @@ 1. __prepare( ___**params___ )__ 1. __parse_parameters( ___**params___ )__ 1. __check_run_permissions( )__ - Should raise an exception if the current [Context] does not have the privileges or roles required to perform the specified action. + 1. __run( )__ 1. __epilogue( )__ 1. __audit_action( )__ 1. Return value of __get_result( )__ is the result of the run_command method. +##Methods + + Method | Description + --------- | ---------------- + command_name() | Returns the string name of the command, as in ___domain::action___ + get_result() | Returns the assigned command result, only useful to the [Context] after the Command has been executed. + generate_object_id() | For use by the Command's run() method, generates a new unique objectId for any new entities created. + set_result( value ) | Set the value to be returned by the Command to the [Context]. Every call overwrites the previous value. + set_return_value( date, right='r' ) | Set the return value of the Command to an entity or list of entities - reducing that list to only those for which the Context has the specified privilege. </pre> </div>Adam Tauno WilliamsSat, 27 Apr 2013 13:04:22 -0000https://sourceforge.net4bcb8eccf47a08760b8f8ac589a6510993440bfahttps://sourceforge.net/p/coils/wiki/LogicCommand/<div class="markdown_content"><p><a class="alink" href="/p/coils/wiki/Development/">[Development]</a></p> <div class="toc"> <ul> <li><a href="#logic-commands">Logic Commands</a><ul> <li><a href="#sequence-of-operations">Sequence Of Operations</a></li> </ul> </li> </ul> </div> <h1 id="logic-commands">Logic Commands</h1> <p>Logic commands are always executed using the "run_command" method of a <a class="alink" href="/p/coils/wiki/Context/">[Context]</a> instance.</p> <div class="codehilite"><pre><span class="n">ctx</span> <span class="p">=</span> <span class="n">AdminsitrativeContext</span><span class="p">()</span> <span class="n">result</span> <span class="p">=</span> <span class="n">ctx</span><span class="p">.</span><span class="n">run_command</span><span class="p">(</span> <span class="s">'project::get'</span><span class="p">,</span> <span class="n">number</span><span class="p">=</span><span class="s">'Wiki Project'</span> <span class="p">)</span> </pre></div> <p>For scripting and interactive use the <span>[Contact]</span> method "r_c" exists as a short-cut for "run_command". But formal code committed to the repository should always use the long form.</p> <h2 id="sequence-of-operations">Sequence Of Operations</h2> <ol> <li><strong>ctor</strong></li> <li><strong>prepare( <strong><em>**params</em></strong> )</strong><ol> <li><strong>parse_parameters( <strong><em>**params</em></strong> )</strong></li> <li><strong>check_run_permissions( )</strong> - Should raise an exception if the current <a class="alink" href="/p/coils/wiki/Context/">[Context]</a> does not have the privileges or roles required to perform the specified action.</li> </ol> </li> <li><strong>epilogue( )</strong><ol> <li><strong>audit_action( )</strong></li> </ol> </li> <li>Return value of <strong>get_result( )</strong> is the result of the run_command method.</li> </ol></div>Adam Tauno WilliamsSat, 27 Apr 2013 12:59:49 -0000https://sourceforge.netc7b547e93f1cfdc7ea0bd5ae069816d8747eea5d