doc/TaskJuggler/ProjectBrokerIface.html in taskjuggler-0.0.6 vs doc/TaskJuggler/ProjectBrokerIface.html in taskjuggler-0.0.7

- old
+ new

@@ -73,10 +73,12 @@ <li><a href="#method-i-apiVersion">#apiVersion</a></li> <li><a href="#method-i-command">#command</a></li> + <li><a href="#method-i-trap">#trap</a></li> + <li><a href="#method-i-updateState">#updateState</a></li> </ul> </div> @@ -167,10 +169,14 @@ <li><a href="../TaskJuggler/DependencyListAttribute.html">TaskJuggler::DependencyListAttribute</a></li> <li><a href="../TaskJuggler/DurationAttribute.html">TaskJuggler::DurationAttribute</a></li> + <li><a href="../TaskJuggler/FileList.html">TaskJuggler::FileList</a></li> + + <li><a href="../TaskJuggler/FileRecord.html">TaskJuggler::FileRecord</a></li> + <li><a href="../TaskJuggler/FixnumAttribute.html">TaskJuggler::FixnumAttribute</a></li> <li><a href="../TaskJuggler/FlagListAttribute.html">TaskJuggler::FlagListAttribute</a></li> <li><a href="../TaskJuggler/FloatAttribute.html">TaskJuggler::FloatAttribute</a></li> @@ -239,12 +245,10 @@ <li><a href="../TaskJuggler/LogicalOperation.html">TaskJuggler::LogicalOperation</a></li> <li><a href="../TaskJuggler/Macro.html">TaskJuggler::Macro</a></li> - <li><a href="../TaskJuggler/MacroParser.html">TaskJuggler::MacroParser</a></li> - <li><a href="../TaskJuggler/MacroTable.html">TaskJuggler::MacroTable</a></li> <li><a href="../TaskJuggler/ManagerResponsibilities.html">TaskJuggler::ManagerResponsibilities</a></li> <li><a href="../TaskJuggler/ManagerStatusRecord.html">TaskJuggler::ManagerStatusRecord</a></li> @@ -305,10 +309,12 @@ <li><a href="../TaskJuggler/RTFReport.html">TaskJuggler::RTFReport</a></li> <li><a href="../TaskJuggler/RTFReportLink.html">TaskJuggler::RTFReportLink</a></li> + <li><a href="../TaskJuggler/RTFWithQuerySupport.html">TaskJuggler::RTFWithQuerySupport</a></li> + <li><a href="../TaskJuggler/RealFormat.html">TaskJuggler::RealFormat</a></li> <li><a href="../TaskJuggler/RealFormatAttribute.html">TaskJuggler::RealFormatAttribute</a></li> <li><a href="../TaskJuggler/ReferenceAttribute.html">TaskJuggler::ReferenceAttribute</a></li> @@ -351,12 +357,10 @@ <li><a href="../TaskJuggler/RichTextDocument.html">TaskJuggler::RichTextDocument</a></li> <li><a href="../TaskJuggler/RichTextElement.html">TaskJuggler::RichTextElement</a></li> - <li><a href="../TaskJuggler/RichTextException.html">TaskJuggler::RichTextException</a></li> - <li><a href="../TaskJuggler/RichTextFunctionExample.html">TaskJuggler::RichTextFunctionExample</a></li> <li><a href="../TaskJuggler/RichTextFunctionHandler.html">TaskJuggler::RichTextFunctionHandler</a></li> <li><a href="../TaskJuggler/RichTextImage.html">TaskJuggler::RichTextImage</a></li> @@ -393,10 +397,12 @@ <li><a href="../TaskJuggler/ShiftAssignmentsAttribute.html">TaskJuggler::ShiftAssignmentsAttribute</a></li> <li><a href="../TaskJuggler/ShiftScenario.html">TaskJuggler::ShiftScenario</a></li> + <li><a href="../TaskJuggler/SimpleQueryExpander.html">TaskJuggler::SimpleQueryExpander</a></li> + <li><a href="../TaskJuggler/SortListAttribute.html">TaskJuggler::SortListAttribute</a></li> <li><a href="../TaskJuggler/SourceFileInfo.html">TaskJuggler::SourceFileInfo</a></li> <li><a href="../TaskJuggler/StatusSheetReceiver.html">TaskJuggler::StatusSheetReceiver</a></li> @@ -503,10 +509,12 @@ <li><a href="../TaskJuggler/URLParameter.html">TaskJuggler::URLParameter</a></li> <li><a href="../TaskJuggler/UserManual.html">TaskJuggler::UserManual</a></li> + <li><a href="../TaskJuggler/VimSyntax.html">TaskJuggler::VimSyntax</a></li> + <li><a href="../TaskJuggler/WebServer.html">TaskJuggler::WebServer</a></li> <li><a href="../TaskJuggler/WorkingHours.html">TaskJuggler::WorkingHours</a></li> <li><a href="../TaskJuggler/WorkingHoursAttribute.html">TaskJuggler::WorkingHoursAttribute</a></li> @@ -585,14 +593,14 @@ <div class="method-source-code" id="new-source"> <pre> - <span class="ruby-comment cmt"># File lib/daemon/ProjectBroker.rb, line 399</span> -399: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">broker</span>) -400: <span class="ruby-ivar">@broker</span> = <span class="ruby-identifier">broker</span> -401: <span class="ruby-keyword kw">end</span></pre> + <span class="ruby-comment cmt"># File lib/daemon/ProjectBroker.rb, line 455</span> +455: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">broker</span>) +456: <span class="ruby-ivar">@broker</span> = <span class="ruby-identifier">broker</span> +457: <span class="ruby-keyword kw">end</span></pre> </div> </div> @@ -630,16 +638,16 @@ <div class="method-source-code" id="api-ersion-source"> <pre> - <span class="ruby-comment cmt"># File lib/daemon/ProjectBroker.rb, line 408</span> -408: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">apiVersion</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-identifier">version</span>) -409: <span class="ruby-keyword kw">return</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">checkKey</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-value str">'apiVersion'</span>) -410: -411: <span class="ruby-identifier">version</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-operator">?</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">1</span> -412: <span class="ruby-keyword kw">end</span></pre> + <span class="ruby-comment cmt"># File lib/daemon/ProjectBroker.rb, line 464</span> +464: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">apiVersion</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-identifier">version</span>) +465: <span class="ruby-keyword kw">return</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">checkKey</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-value str">'apiVersion'</span>) +466: +467: <span class="ruby-identifier">version</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-operator">?</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">1</span> +468: <span class="ruby-keyword kw">end</span></pre> </div> </div> @@ -666,46 +674,95 @@ <div class="method-source-code" id="command-source"> <pre> - <span class="ruby-comment cmt"># File lib/daemon/ProjectBroker.rb, line 414</span> -414: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">command</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">args</span>) -415: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">checkKey</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-identifier">cmd</span>) -416: -417: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">cmd</span> -418: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:status</span> -419: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">status</span> -420: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:stop</span> -421: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">stop</span> -422: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:addProject</span> -423: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">addProject</span> -424: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:removeProject</span> -425: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">removeProject</span>(<span class="ruby-identifier">args</span>) -426: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:getProject</span> -427: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">getProject</span>(<span class="ruby-identifier">args</span>) -428: <span class="ruby-keyword kw">else</span> -429: <span class="ruby-constant">LogFile</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">fatal</span>(<span class="ruby-value str">'Unknown command #{cmd} called'</span>) -430: <span class="ruby-keyword kw">end</span> -431: <span class="ruby-keyword kw">end</span></pre> + <span class="ruby-comment cmt"># File lib/daemon/ProjectBroker.rb, line 484</span> +484: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">command</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">args</span>) +485: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">checkKey</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-identifier">cmd</span>) +486: +487: <span class="ruby-identifier">trap</span> <span class="ruby-keyword kw">do</span> +488: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">cmd</span> +489: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:status</span> +490: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">status</span> +491: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:stop</span> +492: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">stop</span> +493: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:addProject</span> +494: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">addProject</span> +495: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:removeProject</span> +496: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">removeProject</span>(<span class="ruby-identifier">args</span>) +497: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:getProject</span> +498: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">getProject</span>(<span class="ruby-identifier">args</span>) +499: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:update</span> +500: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">update</span> +501: <span class="ruby-keyword kw">else</span> +502: <span class="ruby-constant">LogFile</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">fatal</span>(<span class="ruby-value str">'Unknown command #{cmd} called'</span>) +503: <span class="ruby-keyword kw">end</span> +504: <span class="ruby-keyword kw">end</span> +505: <span class="ruby-keyword kw">end</span></pre> </div> </div> </div> + <div id="trap-method" class="method-detail "> + <a name="method-i-trap"></a> + + <div class="method-heading"> + + <span class="method-name">trap</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +This function catches all unhandled exceptions in the passed block. +</p> + + + + <div class="method-source-code" + id="trap-source"> +<pre> + <span class="ruby-comment cmt"># File lib/daemon/ProjectBroker.rb, line 471</span> +471: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">trap</span> +472: <span class="ruby-identifier">log</span> = <span class="ruby-constant">LogFile</span>.<span class="ruby-identifier">instance</span> +473: +474: <span class="ruby-keyword kw">begin</span> +475: <span class="ruby-keyword kw">yield</span> +476: <span class="ruby-keyword kw">rescue</span> +477: <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">$!</span>.<span class="ruby-identifier">to_s</span> +478: <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">$!</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>) +479: <span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-identifier">$!</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>)) +480: <span class="ruby-identifier">log</span>.<span class="ruby-identifier">fatal</span>(<span class="ruby-node">&quot;Unexpected exception: #{$!}&quot;</span>) +481: <span class="ruby-keyword kw">end</span> +482: <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + + + </div> + + <div id="update-tate-method" class="method-detail "> <a name="method-i-updateState"></a> <div class="method-heading"> <span class="method-name">updateState</span><span - class="method-args">(authKey, id, status)</span> + class="method-args">(authKey, id, status, modified)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> @@ -715,13 +772,13 @@ <div class="method-source-code" id="update-tate-source"> <pre> - <span class="ruby-comment cmt"># File lib/daemon/ProjectBroker.rb, line 433</span> -433: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">updateState</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">status</span>) -434: <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">updateState</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">status</span>) -435: <span class="ruby-keyword kw">end</span></pre> + <span class="ruby-comment cmt"># File lib/daemon/ProjectBroker.rb, line 507</span> +507: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">updateState</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">modified</span>) +508: <span class="ruby-identifier">trap</span> { <span class="ruby-ivar">@broker</span>.<span class="ruby-identifier">updateState</span>(<span class="ruby-identifier">authKey</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">modified</span>) } +509: <span class="ruby-keyword kw">end</span></pre> </div> </div>