Loading...
Helix SwarmHelix Swarm
Loading...

Plan.html

  • //
  • guest/
  • doug_scheirer/
  • helix-web-services/
  • main/
  • build/
  • doc/
  • helix_web_services/
  • HelixSync/
  • Methods/
  • Plan.html #9
  • View
  • Commits
  • Open Download .zip Download (12 KB) 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4.   <head>
  5.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>
  7.   Class: HelixSync::Methods::Plan
  8.   
  9.     &mdash; Documentation by YARD 0.8.7.6
  10.   
  11. </title>
  12.  
  13.   <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
  14.  
  15.   <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
  16.  
  17. <script type="text/javascript" charset="utf-8">
  18.   hasFrames = window.top.frames.main ? true : false;
  19.   relpath = '../../';
  20.   framesUrl = "../../frames.html#!HelixSync/Methods/Plan.html";
  21. </script>
  22.  
  23.  
  24.   <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
  25.  
  26.   <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
  27.  
  28.  
  29.   </head>
  30.   <body>
  31.     <div id="header">
  32.       <div id="menu">
  33.   
  34.     <a href="../../_index.html">Index (P)</a> &raquo;
  35.     <span class='title'><span class='object_link'><a href="../../HelixSync.html" title="HelixSync (module)">HelixSync</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Methods.html" title="HelixSync::Methods (module)">Methods</a></span></span>
  36.      &raquo; 
  37.     <span class="title">Plan</span>
  38.   
  39.  
  40.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  41. </div>
  42.  
  43.       <div id="search">
  44.   
  45.     <a class="full_list_link" id="class_list_link"
  46.         href="../../class_list.html">
  47.       Class List
  48.     </a>
  49.   
  50.     <a class="full_list_link" id="method_list_link"
  51.         href="../../method_list.html">
  52.       Method List
  53.     </a>
  54.   
  55.     <a class="full_list_link" id="file_list_link"
  56.         href="../../file_list.html">
  57.       File List
  58.     </a>
  59.   
  60. </div>
  61.       <div class="clear"></div>
  62.     </div>
  63.  
  64.     <iframe id="search_frame"></iframe>
  65.  
  66.     <div id="content"><h1>Class: HelixSync::Methods::Plan
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.     <dt class="r1">Inherits:</dt>
  75.     <dd class="r1">
  76.       <span class="inheritName">Object</span>
  77.       
  78.         <ul class="fullTree">
  79.           <li>Object</li>
  80.           
  81.             <li class="next">HelixSync::Methods::Plan</li>
  82.           
  83.         </ul>
  84.         <a href="#" class="inheritanceTree">show all</a>
  85.       
  86.       </dd>
  87.     
  88.   
  89.   
  90.     
  91.   
  92.     
  93.   
  94.   
  95.   
  96.     <dt class="r2 last">Defined in:</dt>
  97.     <dd class="r2 last">lib/helix_sync/methods.rb</dd>
  98.   
  99. </dl>
  100. <div class="clear"></div>
  101.  
  102.  
  103.  
  104.  
  105.  
  106.   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
  107.   <ul class="summary">
  108.     
  109.       <li class="public ">
  110.   <span class="summary_signature">
  111.     
  112.       <a href="#subplans-instance_method" title="#subplans (instance method)">- (Object) <strong>subplans</strong> </a>
  113.     
  114.  
  115.     
  116.   </span>
  117.   
  118.   
  119.   
  120.     
  121.     
  122.   
  123.   
  124.   
  125.   
  126.   
  127.  
  128.   
  129.     <span class="summary_desc"><div class='inline'>
  130. <p>Array of Subplan instances.</p>
  131. </div></span>
  132.   
  133. </li>
  134.  
  135.     
  136.   </ul>
  137.  
  138.  
  139.  
  140.  
  141.   
  142.     <h2>
  143.       Instance Method Summary
  144.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  145.     </h2>
  146.  
  147.     <ul class="summary">
  148.       
  149.         <li class="public ">
  150.   <span class="summary_signature">
  151.     
  152.       <a href="#empty%3F-instance_method" title="#empty? (instance method)">- (Boolean) <strong>empty?</strong> </a>
  153.     
  154.  
  155.     
  156.   </span>
  157.   
  158.   
  159.   
  160.   
  161.   
  162.   
  163.   
  164.  
  165.   
  166.     <span class="summary_desc"><div class='inline'></div></span>
  167.   
  168. </li>
  169.  
  170.       
  171.         <li class="public ">
  172.   <span class="summary_signature">
  173.     
  174.       <a href="#initialize-instance_method" title="#initialize (instance method)">- (Plan) <strong>initialize</strong> </a>
  175.     
  176.  
  177.     
  178.   </span>
  179.   
  180.   
  181.     <span class="note title constructor">constructor</span>
  182.   
  183.   
  184.   
  185.   
  186.   
  187.   
  188.  
  189.   
  190.     <span class="summary_desc"><div class='inline'>
  191. <p>A new instance of Plan.</p>
  192. </div></span>
  193.   
  194. </li>
  195.  
  196.       
  197.         <li class="public ">
  198.   <span class="summary_signature">
  199.     
  200.       <a href="#readd_actions-instance_method" title="#readd_actions (instance method)">- (Object) <strong>readd_actions</strong> </a>
  201.     
  202.  
  203.     
  204.   </span>
  205.   
  206.   
  207.   
  208.   
  209.   
  210.   
  211.   
  212.  
  213.   
  214.     <span class="summary_desc"><div class='inline'></div></span>
  215.   
  216. </li>
  217.  
  218.       
  219.         <li class="public ">
  220.   <span class="summary_signature">
  221.     
  222.       <a href="#remove_actions-instance_method" title="#remove_actions (instance method)">- (Object) <strong>remove_actions</strong> </a>
  223.     
  224.  
  225.     
  226.   </span>
  227.   
  228.   
  229.   
  230.   
  231.   
  232.   
  233.   
  234.  
  235.   
  236.     <span class="summary_desc"><div class='inline'></div></span>
  237.   
  238. </li>
  239.  
  240.       
  241.         <li class="public ">
  242.   <span class="summary_signature">
  243.     
  244.       <a href="#resolve_actions-instance_method" title="#resolve_actions (instance method)">- (Object) <strong>resolve_actions</strong> </a>
  245.     
  246.  
  247.     
  248.   </span>
  249.   
  250.   
  251.   
  252.   
  253.   
  254.   
  255.   
  256.  
  257.   
  258.     <span class="summary_desc"><div class='inline'></div></span>
  259.   
  260. </li>
  261.  
  262.       
  263.         <li class="public ">
  264.   <span class="summary_signature">
  265.     
  266.       <a href="#to_json-instance_method" title="#to_json (instance method)">- (Object) <strong>to_json</strong> </a>
  267.     
  268.  
  269.     
  270.   </span>
  271.   
  272.   
  273.   
  274.   
  275.   
  276.   
  277.   
  278.  
  279.   
  280.     <span class="summary_desc"><div class='inline'></div></span>
  281.   
  282. </li>
  283.  
  284.       
  285.     </ul>
  286.   
  287.  
  288. <div id="constructor_details" class="method_details_list">
  289.   <h2>Constructor Details</h2>
  290.   
  291.     <div class="method_details first">
  292.   <h3 class="signature first" id="initialize-instance_method">
  293.   
  294.     - (<tt><span class='object_link'><a href="" title="HelixSync::Methods::Plan (class)">Plan</a></span></tt>) <strong>initialize</strong> 
  295.   
  296.  
  297.   
  298.  
  299.   
  300. </h3><div class="docstring">
  301.   <div class="discussion">
  302.     
  303. <p>Returns a new instance of Plan</p>
  304.  
  305.  
  306.   </div>
  307. </div>
  308. <div class="tags">
  309.   
  310.  
  311. </div><table class="source_code">
  312.   <tr>
  313.     <td>
  314.       <pre class="lines">
  315.  
  316.  
  317. 526
  318. 527
  319. 528</pre>
  320.     </td>
  321.     <td>
  322.       <pre class="code"><span class="info file"># File 'lib/helix_sync/methods.rb', line 526</span>
  323.  
  324. <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
  325.   <span class='ivar'>@subplans</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
  326. <span class='kw'>end</span></pre>
  327.     </td>
  328.   </tr>
  329. </table>
  330. </div>
  331.   
  332. </div>
  333.  
  334.   <div id="instance_attr_details" class="attr_details">
  335.     <h2>Instance Attribute Details</h2>
  336.     
  337.       
  338.       <span id="subplans=-instance_method"></span>
  339.       <div class="method_details first">
  340.   <h3 class="signature first" id="subplans-instance_method">
  341.   
  342.     - (<tt>Object</tt>) <strong>subplans</strong> 
  343.   
  344.  
  345.   
  346.  
  347.   
  348. </h3><div class="docstring">
  349.   <div class="discussion">
  350.     
  351. <p>Array of Subplan instances</p>
  352.  
  353.  
  354.   </div>
  355. </div>
  356. <div class="tags">
  357.   
  358.  
  359. </div><table class="source_code">
  360.   <tr>
  361.     <td>
  362.       <pre class="lines">
  363.  
  364.  
  365. 524
  366. 525
  367. 526</pre>
  368.     </td>
  369.     <td>
  370.       <pre class="code"><span class="info file"># File 'lib/helix_sync/methods.rb', line 524</span>
  371.  
  372. <span class='kw'>def</span> <span class='id identifier rubyid_subplans'>subplans</span>
  373.   <span class='ivar'>@subplans</span>
  374. <span class='kw'>end</span></pre>
  375.     </td>
  376.   </tr>
  377. </table>
  378. </div>
  379.     
  380.   </div>
  381.  
  382.  
  383.   <div id="instance_method_details" class="method_details_list">
  384.     <h2>Instance Method Details</h2>
  385.  
  386.     
  387.       <div class="method_details first">
  388.   <h3 class="signature first" id="empty?-instance_method">
  389.   
  390.     - (<tt>Boolean</tt>) <strong>empty?</strong> 
  391.   
  392.  
  393.   
  394.  
  395.   
  396. </h3><div class="docstring">
  397.   <div class="discussion">
  398.     
  399.  
  400.   </div>
  401. </div>
  402. <div class="tags">
  403.   
  404. <p class="tag_title">Returns:</p>
  405. <ul class="return">
  406.   
  407.     <li>
  408.       
  409.       
  410.         <span class='type'>(<tt>Boolean</tt>)</span>
  411.       
  412.       
  413.       
  414.     </li>
  415.   
  416. </ul>
  417.  
  418. </div><table class="source_code">
  419.   <tr>
  420.     <td>
  421.       <pre class="lines">
  422.  
  423.  
  424. 530
  425. 531
  426. 532</pre>
  427.     </td>
  428.     <td>
  429.       <pre class="code"><span class="info file"># File 'lib/helix_sync/methods.rb', line 530</span>
  430.  
  431. <span class='kw'>def</span> <span class='id identifier rubyid_empty?'>empty?</span>
  432.   <span class='ivar'>@subplans</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
  433. <span class='kw'>end</span></pre>
  434.     </td>
  435.   </tr>
  436. </table>
  437. </div>
  438.     
  439.       <div class="method_details ">
  440.   <h3 class="signature " id="readd_actions-instance_method">
  441.   
  442.     - (<tt>Object</tt>) <strong>readd_actions</strong> 
  443.   
  444.  
  445.   
  446.  
  447.   
  448. </h3><table class="source_code">
  449.   <tr>
  450.     <td>
  451.       <pre class="lines">
  452.  
  453.  
  454. 538
  455. 539
  456. 540</pre>
  457.     </td>
  458.     <td>
  459.       <pre class="code"><span class="info file"># File 'lib/helix_sync/methods.rb', line 538</span>
  460.  
  461. <span class='kw'>def</span> <span class='id identifier rubyid_readd_actions'>readd_actions</span>
  462.   <span class='ivar'>@subplans</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_sync_conflict'>sync_conflict</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>readd</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
  463. <span class='kw'>end</span></pre>
  464.     </td>
  465.   </tr>
  466. </table>
  467. </div>
  468.     
  469.       <div class="method_details ">
  470.   <h3 class="signature " id="remove_actions-instance_method">
  471.   
  472.     - (<tt>Object</tt>) <strong>remove_actions</strong> 
  473.   
  474.  
  475.   
  476.  
  477.   
  478. </h3><table class="source_code">
  479.   <tr>
  480.     <td>
  481.       <pre class="lines">
  482.  
  483.  
  484. 534
  485. 535
  486. 536</pre>
  487.     </td>
  488.     <td>
  489.       <pre class="code"><span class="info file"># File 'lib/helix_sync/methods.rb', line 534</span>
  490.  
  491. <span class='kw'>def</span> <span class='id identifier rubyid_remove_actions'>remove_actions</span>
  492.   <span class='ivar'>@subplans</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_sync_conflict'>sync_conflict</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>remove</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
  493. <span class='kw'>end</span></pre>
  494.     </td>
  495.   </tr>
  496. </table>
  497. </div>
  498.     
  499.       <div class="method_details ">
  500.   <h3 class="signature " id="resolve_actions-instance_method">
  501.   
  502.     - (<tt>Object</tt>) <strong>resolve_actions</strong> 
  503.   
  504.  
  505.   
  506.  
  507.   
  508. </h3><table class="source_code">
  509.   <tr>
  510.     <td>
  511.       <pre class="lines">
  512.  
  513.  
  514. 542
  515. 543
  516. 544</pre>
  517.     </td>
  518.     <td>
  519.       <pre class="code"><span class="info file"># File 'lib/helix_sync/methods.rb', line 542</span>
  520.  
  521. <span class='kw'>def</span> <span class='id identifier rubyid_resolve_actions'>resolve_actions</span>
  522.   <span class='ivar'>@subplans</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_sync_conflict'>sync_conflict</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>resolve</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
  523. <span class='kw'>end</span></pre>
  524.     </td>
  525.   </tr>
  526. </table>
  527. </div>
  528.     
  529.       <div class="method_details ">
  530.   <h3 class="signature " id="to_json-instance_method">
  531.   
  532.     - (<tt>Object</tt>) <strong>to_json</strong> 
  533.   
  534.  
  535.   
  536.  
  537.   
  538. </h3><table class="source_code">
  539.   <tr>
  540.     <td>
  541.       <pre class="lines">
  542.  
  543.  
  544. 546
  545. 547
  546. 548</pre>
  547.     </td>
  548.     <td>
  549.       <pre class="code"><span class="info file"># File 'lib/helix_sync/methods.rb', line 546</span>
  550.  
  551. <span class='kw'>def</span> <span class='id identifier rubyid_to_json'>to_json</span>
  552.   <span class='ivar'>@subplans</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
  553. <span class='kw'>end</span></pre>
  554.     </td>
  555.   </tr>
  556. </table>
  557. </div>
  558.     
  559.   </div>
  560.  
  561. </div>
  562.  
  563.     <div id="footer">
  564.   Generated on Mon Oct 12 22:20:52 2015 by
  565.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  566.   0.8.7.6 (ruby-2.2.3).
  567. </div>
  568.  
  569.   </body>
  570. </html>
# Change User Description Committed
#9 16275 Doug Scheirer Merge from main 9 years ago
#8 16196 Doug Scheirer Merge from main 9 years ago
#7 16148 Doug Scheirer Merge from main 9 years ago
#6 16114 Doug Scheirer Merge from main 9 years ago
#5 16079 Doug Scheirer Merge from main 9 years ago
#4 16014 Doug Scheirer Merge down from main 9 years ago
#3 15884 Doug Scheirer Merge from main 9 years ago
#2 15868 Doug Scheirer Merge from main 9 years ago
#1 15845 Doug Scheirer Integ from main 9 years ago
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services/HelixSync/Methods/Plan.html
#1 15836 tjuricek HWS/NOARCH/2015.1.main/201509221612 9 years ago
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services/HelixVersioningEngine/HVEProjectsService/Plan.html
#4 15826 tjuricek HWS/NOARCH/2015.1.main/201509212055 9 years ago
#3 15783 tjuricek HWS/NOARCH/2015.1.main/201509180120 9 years ago
#2 15769 tjuricek HWS/NOARCH/2015.1.main/201509170120 9 years ago
#1 15758 tjuricek HWS/NOARCH/2015.1.main/201509161743 10 years ago