repository-support 0.1.1 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,464 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Repository::Support::StoreResult
8
+
9
+ &mdash; Documentation by YARD 0.9.12
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
+ pathId = "Repository::Support::StoreResult";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Repository.html" title="Repository (module)">Repository</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Support.html" title="Repository::Support (module)">Support</a></span></span>
41
+ &raquo;
42
+ <span class="title">StoreResult</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Repository::Support::StoreResult
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Repository::Support::StoreResult</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/repository/support/store_result.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Uniform representation of success or failure of a storage-command action.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div><div id="subclasses">
114
+ <h2>Direct Known Subclasses</h2>
115
+ <p class="children"><span class='object_link'><a href="StoreResult/Failure.html" title="Repository::Support::StoreResult::Failure (class)">Failure</a></span>, <span class='object_link'><a href="StoreResult/Success.html" title="Repository::Support::StoreResult::Success (class)">Success</a></span></p>
116
+ </div>
117
+ <h2>Defined Under Namespace</h2>
118
+ <p class="children">
119
+
120
+
121
+
122
+
123
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="StoreResult/Failure.html" title="Repository::Support::StoreResult::Failure (class)">Failure</a></span>, <span class='object_link'><a href="StoreResult/Success.html" title="Repository::Support::StoreResult::Success (class)">Success</a></span>
124
+
125
+
126
+ </p>
127
+
128
+
129
+
130
+
131
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
132
+ <ul class="summary">
133
+
134
+ <li class="public ">
135
+ <span class="summary_signature">
136
+
137
+ <a href="#entity-instance_method" title="#entity (instance method)">#<strong>entity</strong> &#x21d2; Object </a>
138
+
139
+
140
+
141
+ </span>
142
+
143
+
144
+
145
+
146
+ <span class="note title readonly">readonly</span>
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+ <span class="summary_desc"><div class='inline'>
157
+ <p>class Repository::Support::StoreResult::Failure.</p>
158
+ </div></span>
159
+
160
+ </li>
161
+
162
+
163
+ <li class="public ">
164
+ <span class="summary_signature">
165
+
166
+ <a href="#errors-instance_method" title="#errors (instance method)">#<strong>errors</strong> &#x21d2; Object </a>
167
+
168
+
169
+
170
+ </span>
171
+
172
+
173
+
174
+
175
+ <span class="note title readonly">readonly</span>
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+ <span class="summary_desc"><div class='inline'>
186
+ <p>class Repository::Support::StoreResult::Failure.</p>
187
+ </div></span>
188
+
189
+ </li>
190
+
191
+
192
+ <li class="public ">
193
+ <span class="summary_signature">
194
+
195
+ <a href="#success-instance_method" title="#success (instance method)">#<strong>success</strong> &#x21d2; Object </a>
196
+
197
+
198
+
199
+ (also: #success?)
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+ <span class="note title readonly">readonly</span>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+ <span class="summary_desc"><div class='inline'>
217
+ <p>class Repository::Support::StoreResult::Failure.</p>
218
+ </div></span>
219
+
220
+ </li>
221
+
222
+
223
+ </ul>
224
+
225
+
226
+
227
+
228
+
229
+ <h2>
230
+ Instance Method Summary
231
+ <small><a href="#" class="summary_toggle">collapse</a></small>
232
+ </h2>
233
+
234
+ <ul class="summary">
235
+
236
+ <li class="public ">
237
+ <span class="summary_signature">
238
+
239
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(entity:, errors:, success:) &#x21d2; StoreResult </a>
240
+
241
+
242
+
243
+ </span>
244
+
245
+
246
+ <span class="note title constructor">constructor</span>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+ <span class="summary_desc"><div class='inline'>
256
+ <p>A new instance of StoreResult.</p>
257
+ </div></span>
258
+
259
+ </li>
260
+
261
+
262
+ </ul>
263
+
264
+
265
+ <div id="constructor_details" class="method_details_list">
266
+ <h2>Constructor Details</h2>
267
+
268
+ <div class="method_details first">
269
+ <h3 class="signature first" id="initialize-instance_method">
270
+
271
+ #<strong>initialize</strong>(entity:, errors:, success:) &#x21d2; <tt><span class='object_link'><a href="" title="Repository::Support::StoreResult (class)">StoreResult</a></span></tt>
272
+
273
+
274
+
275
+
276
+
277
+ </h3><div class="docstring">
278
+ <div class="discussion">
279
+
280
+ <p>Returns a new instance of StoreResult</p>
281
+
282
+
283
+ </div>
284
+ </div>
285
+ <div class="tags">
286
+
287
+
288
+ </div><table class="source_code">
289
+ <tr>
290
+ <td>
291
+ <pre class="lines">
292
+
293
+
294
+ 24
295
+ 25
296
+ 26
297
+ 27
298
+ 28</pre>
299
+ </td>
300
+ <td>
301
+ <pre class="code"><span class="info file"># File 'lib/repository/support/store_result.rb', line 24</span>
302
+
303
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>entity:</span><span class='comma'>,</span> <span class='label'>errors:</span><span class='comma'>,</span> <span class='label'>success:</span><span class='rparen'>)</span>
304
+ <span class='ivar'>@entity</span> <span class='op'>=</span> <span class='id identifier rubyid_entity'>entity</span>
305
+ <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span>
306
+ <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span>
307
+ <span class='kw'>end</span></pre>
308
+ </td>
309
+ </tr>
310
+ </table>
311
+ </div>
312
+
313
+ </div>
314
+
315
+ <div id="instance_attr_details" class="attr_details">
316
+ <h2>Instance Attribute Details</h2>
317
+
318
+
319
+ <span id=""></span>
320
+ <div class="method_details first">
321
+ <h3 class="signature first" id="entity-instance_method">
322
+
323
+ #<strong>entity</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
324
+
325
+
326
+
327
+
328
+
329
+ </h3><div class="docstring">
330
+ <div class="discussion">
331
+
332
+ <p>class Repository::Support::StoreResult::Failure</p>
333
+
334
+
335
+ </div>
336
+ </div>
337
+ <div class="tags">
338
+
339
+
340
+ </div><table class="source_code">
341
+ <tr>
342
+ <td>
343
+ <pre class="lines">
344
+
345
+
346
+ 21
347
+ 22
348
+ 23</pre>
349
+ </td>
350
+ <td>
351
+ <pre class="code"><span class="info file"># File 'lib/repository/support/store_result.rb', line 21</span>
352
+
353
+ <span class='kw'>def</span> <span class='id identifier rubyid_entity'>entity</span>
354
+ <span class='ivar'>@entity</span>
355
+ <span class='kw'>end</span></pre>
356
+ </td>
357
+ </tr>
358
+ </table>
359
+ </div>
360
+
361
+
362
+ <span id=""></span>
363
+ <div class="method_details ">
364
+ <h3 class="signature " id="errors-instance_method">
365
+
366
+ #<strong>errors</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
367
+
368
+
369
+
370
+
371
+
372
+ </h3><div class="docstring">
373
+ <div class="discussion">
374
+
375
+ <p>class Repository::Support::StoreResult::Failure</p>
376
+
377
+
378
+ </div>
379
+ </div>
380
+ <div class="tags">
381
+
382
+
383
+ </div><table class="source_code">
384
+ <tr>
385
+ <td>
386
+ <pre class="lines">
387
+
388
+
389
+ 21
390
+ 22
391
+ 23</pre>
392
+ </td>
393
+ <td>
394
+ <pre class="code"><span class="info file"># File 'lib/repository/support/store_result.rb', line 21</span>
395
+
396
+ <span class='kw'>def</span> <span class='id identifier rubyid_errors'>errors</span>
397
+ <span class='ivar'>@errors</span>
398
+ <span class='kw'>end</span></pre>
399
+ </td>
400
+ </tr>
401
+ </table>
402
+ </div>
403
+
404
+
405
+ <span id=""></span>
406
+ <div class="method_details ">
407
+ <h3 class="signature " id="success-instance_method">
408
+
409
+ #<strong>success</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
410
+
411
+
412
+
413
+ <span class="aliases">Also known as:
414
+ <span class="names"><span id='success?-instance_method'>success?</span></span>
415
+ </span>
416
+
417
+
418
+
419
+ </h3><div class="docstring">
420
+ <div class="discussion">
421
+
422
+ <p>class Repository::Support::StoreResult::Failure</p>
423
+
424
+
425
+ </div>
426
+ </div>
427
+ <div class="tags">
428
+
429
+
430
+ </div><table class="source_code">
431
+ <tr>
432
+ <td>
433
+ <pre class="lines">
434
+
435
+
436
+ 21
437
+ 22
438
+ 23</pre>
439
+ </td>
440
+ <td>
441
+ <pre class="code"><span class="info file"># File 'lib/repository/support/store_result.rb', line 21</span>
442
+
443
+ <span class='kw'>def</span> <span class='id identifier rubyid_success'>success</span>
444
+ <span class='ivar'>@success</span>
445
+ <span class='kw'>end</span></pre>
446
+ </td>
447
+ </tr>
448
+ </table>
449
+ </div>
450
+
451
+ </div>
452
+
453
+
454
+ </div>
455
+
456
+ <div id="footer">
457
+ Generated on Sun Feb 4 17:26:37 2018 by
458
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
459
+ 0.9.12 (ruby-2.5.0).
460
+ </div>
461
+
462
+ </div>
463
+ </body>
464
+ </html>