UNPKG

29.7 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Class: ResultSet</title>
6
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14</head>
15
16<body>
17
18<div id="main">
19
20 <h1 class="page-title">Class: ResultSet</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2>ResultSet</h2>
32
33
34</header>
35
36<article>
37 <div class="container-overview">
38
39
40
41
42
43 <h4 class="name" id="ResultSet"><span class="type-signature"></span>new ResultSet<span class="signature">(data)</span><span class="type-signature"> &rarr; {<a href="ResultSet.html">ResultSet</a>}</span></h4>
44
45
46
47
48
49<div class="description">
50 An object containing a collection of RecordSet
51</div>
52
53
54
55
56
57
58
59
60
61 <h5>Parameters:</h5>
62
63
64<table class="params">
65 <thead>
66 <tr>
67
68 <th>Name</th>
69
70
71 <th>Type</th>
72
73
74
75
76
77 <th class="last">Description</th>
78 </tr>
79 </thead>
80
81 <tbody>
82
83
84 <tr>
85
86 <td class="name"><code>data</code></td>
87
88
89 <td class="type">
90
91
92<span class="param-type">Array</span>
93
94
95
96 </td>
97
98
99
100
101
102 <td class="description last">A list of values</td>
103 </tr>
104
105
106 </tbody>
107</table>
108
109
110
111
112
113
114<dl class="details">
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141 <dt class="tag-source">Source:</dt>
142 <dd class="tag-source"><ul class="dummy"><li>
143 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line13">line 13</a>
144 </li></ul></dd>
145
146
147
148
149
150
151
152</dl>
153
154
155
156
157
158
159
160
161
162
163
164
165
166<h5>Returns:</h5>
167
168
169<div class="param-desc">
170 An object containing the data
171</div>
172
173
174
175<dl>
176 <dt>
177 Type
178 </dt>
179 <dd>
180
181<span class="param-type"><a href="ResultSet.html">ResultSet</a></span>
182
183
184 </dd>
185</dl>
186
187
188
189
190
191
192 </div>
193
194
195
196
197
198
199
200
201
202
203
204
205 <h3 class="subsection-title">Members</h3>
206
207
208
209<h4 class="name" id="stream"><span class="type-signature"></span>stream<span class="type-signature"></span></h4>
210
211
212
213
214<div class="description">
215 Get a stream reference
216</div>
217
218
219
220
221
222
223
224<dl class="details">
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251 <dt class="tag-source">Source:</dt>
252 <dd class="tag-source"><ul class="dummy"><li>
253 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line64">line 64</a>
254 </li></ul></dd>
255
256
257
258
259
260
261
262</dl>
263
264
265
266
267
268
269
270
271<h4 class="name" id="stream"><span class="type-signature"></span>stream<span class="type-signature"></span></h4>
272
273
274
275
276<div class="description">
277 Get a stream reference
278</div>
279
280
281
282
283
284
285
286<dl class="details">
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313 <dt class="tag-source">Source:</dt>
314 <dd class="tag-source"><ul class="dummy"><li>
315 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line64">line 64</a>
316 </li></ul></dd>
317
318
319
320
321
322
323
324</dl>
325
326
327
328
329
330
331
332
333
334
335 <h3 class="subsection-title">Methods</h3>
336
337
338
339
340
341
342 <h4 class="name" id="fromJSON"><span class="type-signature"></span>fromJSON<span class="signature">()</span><span class="type-signature"></span></h4>
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360<dl class="details">
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387 <dt class="tag-source">Source:</dt>
388 <dd class="tag-source"><ul class="dummy"><li>
389 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line23">line 23</a>
390 </li></ul></dd>
391
392
393
394
395
396
397
398</dl>
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420 <h4 class="name" id="fromJSON"><span class="type-signature"></span>fromJSON<span class="signature">()</span><span class="type-signature"></span></h4>
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438<dl class="details">
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465 <dt class="tag-source">Source:</dt>
466 <dd class="tag-source"><ul class="dummy"><li>
467 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line23">line 23</a>
468 </li></ul></dd>
469
470
471
472
473
474
475
476</dl>
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498 <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(idx)</span><span class="type-signature"> &rarr; {<a href="RecordSet.html">RecordSet</a>}</span></h4>
499
500
501
502
503
504<div class="description">
505 Return a RecordSet at the specified index if available
506</div>
507
508
509
510
511
512
513
514
515
516 <h5>Parameters:</h5>
517
518
519<table class="params">
520 <thead>
521 <tr>
522
523 <th>Name</th>
524
525
526 <th>Type</th>
527
528
529
530
531
532 <th class="last">Description</th>
533 </tr>
534 </thead>
535
536 <tbody>
537
538
539 <tr>
540
541 <td class="name"><code>idx</code></td>
542
543
544 <td class="type">
545
546
547<span class="param-type">Number</span>
548
549
550
551 </td>
552
553
554
555
556
557 <td class="description last">Index position</td>
558 </tr>
559
560
561 </tbody>
562</table>
563
564
565
566
567
568
569<dl class="details">
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596 <dt class="tag-source">Source:</dt>
597 <dd class="tag-source"><ul class="dummy"><li>
598 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line73">line 73</a>
599 </li></ul></dd>
600
601
602
603
604
605
606
607</dl>
608
609
610
611
612
613
614
615
616
617
618
619
620
621<h5>Returns:</h5>
622
623
624<div class="param-desc">
625 record record object
626</div>
627
628
629
630<dl>
631 <dt>
632 Type
633 </dt>
634 <dd>
635
636<span class="param-type"><a href="RecordSet.html">RecordSet</a></span>
637
638
639 </dd>
640</dl>
641
642
643
644
645
646
647
648
649
650
651 <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(idx)</span><span class="type-signature"> &rarr; {<a href="RecordSet.html">RecordSet</a>}</span></h4>
652
653
654
655
656
657<div class="description">
658 Return a RecordSet at the specified index if available
659</div>
660
661
662
663
664
665
666
667
668
669 <h5>Parameters:</h5>
670
671
672<table class="params">
673 <thead>
674 <tr>
675
676 <th>Name</th>
677
678
679 <th>Type</th>
680
681
682
683
684
685 <th class="last">Description</th>
686 </tr>
687 </thead>
688
689 <tbody>
690
691
692 <tr>
693
694 <td class="name"><code>idx</code></td>
695
696
697 <td class="type">
698
699
700<span class="param-type">Number</span>
701
702
703
704 </td>
705
706
707
708
709
710 <td class="description last">Index position</td>
711 </tr>
712
713
714 </tbody>
715</table>
716
717
718
719
720
721
722<dl class="details">
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749 <dt class="tag-source">Source:</dt>
750 <dd class="tag-source"><ul class="dummy"><li>
751 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line73">line 73</a>
752 </li></ul></dd>
753
754
755
756
757
758
759
760</dl>
761
762
763
764
765
766
767
768
769
770
771
772
773
774<h5>Returns:</h5>
775
776
777<div class="param-desc">
778 record record object
779</div>
780
781
782
783<dl>
784 <dt>
785 Type
786 </dt>
787 <dd>
788
789<span class="param-type"><a href="RecordSet.html">RecordSet</a></span>
790
791
792 </dd>
793</dl>
794
795
796
797
798
799
800
801
802
803
804 <h4 class="name" id="setStream"><span class="type-signature"></span>setStream<span class="signature">(stream)</span><span class="type-signature"></span></h4>
805
806
807
808
809
810<div class="description">
811 Set a stream reference
812</div>
813
814
815
816
817
818
819
820
821
822 <h5>Parameters:</h5>
823
824
825<table class="params">
826 <thead>
827 <tr>
828
829 <th>Name</th>
830
831
832 <th>Type</th>
833
834
835
836
837
838 <th class="last">Description</th>
839 </tr>
840 </thead>
841
842 <tbody>
843
844
845 <tr>
846
847 <td class="name"><code>stream</code></td>
848
849
850 <td class="type">
851
852
853<span class="param-type"><a href="Stream.html">Stream</a></span>
854
855
856
857 </td>
858
859
860
861
862
863 <td class="description last">a stream object reference</td>
864 </tr>
865
866
867 </tbody>
868</table>
869
870
871
872
873
874
875<dl class="details">
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902 <dt class="tag-source">Source:</dt>
903 <dd class="tag-source"><ul class="dummy"><li>
904 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line53">line 53</a>
905 </li></ul></dd>
906
907
908
909
910
911
912
913</dl>
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935 <h4 class="name" id="setStream"><span class="type-signature"></span>setStream<span class="signature">(stream)</span><span class="type-signature"></span></h4>
936
937
938
939
940
941<div class="description">
942 Set a stream reference
943</div>
944
945
946
947
948
949
950
951
952
953 <h5>Parameters:</h5>
954
955
956<table class="params">
957 <thead>
958 <tr>
959
960 <th>Name</th>
961
962
963 <th>Type</th>
964
965
966
967
968
969 <th class="last">Description</th>
970 </tr>
971 </thead>
972
973 <tbody>
974
975
976 <tr>
977
978 <td class="name"><code>stream</code></td>
979
980
981 <td class="type">
982
983
984<span class="param-type"><a href="Stream.html">Stream</a></span>
985
986
987
988 </td>
989
990
991
992
993
994 <td class="description last">a stream object reference</td>
995 </tr>
996
997
998 </tbody>
999</table>
1000
1001
1002
1003
1004
1005
1006<dl class="details">
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033 <dt class="tag-source">Source:</dt>
1034 <dd class="tag-source"><ul class="dummy"><li>
1035 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line53">line 53</a>
1036 </li></ul></dd>
1037
1038
1039
1040
1041
1042
1043
1044</dl>
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066 <h4 class="name" id="size"><span class="type-signature"></span>size<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>
1067
1068
1069
1070
1071
1072<div class="description">
1073 Return the count of available records
1074</div>
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088<dl class="details">
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115 <dt class="tag-source">Source:</dt>
1116 <dd class="tag-source"><ul class="dummy"><li>
1117 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line81">line 81</a>
1118 </li></ul></dd>
1119
1120
1121
1122
1123
1124
1125
1126</dl>
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140<h5>Returns:</h5>
1141
1142
1143<div class="param-desc">
1144 length count of records
1145</div>
1146
1147
1148
1149<dl>
1150 <dt>
1151 Type
1152 </dt>
1153 <dd>
1154
1155<span class="param-type">Number</span>
1156
1157
1158 </dd>
1159</dl>
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170 <h4 class="name" id="size"><span class="type-signature"></span>size<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>
1171
1172
1173
1174
1175
1176<div class="description">
1177 Return the count of available records
1178</div>
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192<dl class="details">
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219 <dt class="tag-source">Source:</dt>
1220 <dd class="tag-source"><ul class="dummy"><li>
1221 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line81">line 81</a>
1222 </li></ul></dd>
1223
1224
1225
1226
1227
1228
1229
1230</dl>
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244<h5>Returns:</h5>
1245
1246
1247<div class="param-desc">
1248 length count of records
1249</div>
1250
1251
1252
1253<dl>
1254 <dt>
1255 Type
1256 </dt>
1257 <dd>
1258
1259<span class="param-type">Number</span>
1260
1261
1262 </dd>
1263</dl>
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274 <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"></span></h4>
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292<dl class="details">
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319 <dt class="tag-source">Source:</dt>
1320 <dd class="tag-source"><ul class="dummy"><li>
1321 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line34">line 34</a>
1322 </li></ul></dd>
1323
1324
1325
1326
1327
1328
1329
1330</dl>
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352 <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"></span></h4>
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370<dl class="details">
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397 <dt class="tag-source">Source:</dt>
1398 <dd class="tag-source"><ul class="dummy"><li>
1399 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line34">line 34</a>
1400 </li></ul></dd>
1401
1402
1403
1404
1405
1406
1407
1408</dl>
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430 <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">()</span><span class="type-signature"></span></h4>
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448<dl class="details">
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475 <dt class="tag-source">Source:</dt>
1476 <dd class="tag-source"><ul class="dummy"><li>
1477 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line43">line 43</a>
1478 </li></ul></dd>
1479
1480
1481
1482
1483
1484
1485
1486</dl>
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508 <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">()</span><span class="type-signature"></span></h4>
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526<dl class="details">
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553 <dt class="tag-source">Source:</dt>
1554 <dd class="tag-source"><ul class="dummy"><li>
1555 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line43">line 43</a>
1556 </li></ul></dd>
1557
1558
1559
1560
1561
1562
1563
1564</dl>
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587</article>
1588
1589</section>
1590
1591
1592
1593
1594
1595
1596
1597<section>
1598
1599<header>
1600
1601 <h2>ResultSet</h2>
1602
1603
1604</header>
1605
1606<article>
1607 <div class="container-overview">
1608
1609
1610
1611
1612
1613 <h4 class="name" id="ResultSet"><span class="type-signature"></span>new ResultSet<span class="signature">(data)</span><span class="type-signature"> &rarr; {<a href="ResultSet.html">ResultSet</a>}</span></h4>
1614
1615
1616
1617
1618
1619<div class="description">
1620 An object containing a collection of RecordSet
1621</div>
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631 <h5>Parameters:</h5>
1632
1633
1634<table class="params">
1635 <thead>
1636 <tr>
1637
1638 <th>Name</th>
1639
1640
1641 <th>Type</th>
1642
1643
1644
1645
1646
1647 <th class="last">Description</th>
1648 </tr>
1649 </thead>
1650
1651 <tbody>
1652
1653
1654 <tr>
1655
1656 <td class="name"><code>data</code></td>
1657
1658
1659 <td class="type">
1660
1661
1662<span class="param-type">Array</span>
1663
1664
1665
1666 </td>
1667
1668
1669
1670
1671
1672 <td class="description last">A list of values</td>
1673 </tr>
1674
1675
1676 </tbody>
1677</table>
1678
1679
1680
1681
1682
1683
1684<dl class="details">
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711 <dt class="tag-source">Source:</dt>
1712 <dd class="tag-source"><ul class="dummy"><li>
1713 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line13">line 13</a>
1714 </li></ul></dd>
1715
1716
1717
1718
1719
1720
1721
1722</dl>
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736<h5>Returns:</h5>
1737
1738
1739<div class="param-desc">
1740 An object containing the data
1741</div>
1742
1743
1744
1745<dl>
1746 <dt>
1747 Type
1748 </dt>
1749 <dd>
1750
1751<span class="param-type"><a href="ResultSet.html">ResultSet</a></span>
1752
1753
1754 </dd>
1755</dl>
1756
1757
1758
1759
1760
1761
1762 </div>
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775 <h3 class="subsection-title">Members</h3>
1776
1777
1778
1779<h4 class="name" id="stream"><span class="type-signature"></span>stream<span class="type-signature"></span></h4>
1780
1781
1782
1783
1784<div class="description">
1785 Get a stream reference
1786</div>
1787
1788
1789
1790
1791
1792
1793
1794<dl class="details">
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821 <dt class="tag-source">Source:</dt>
1822 <dd class="tag-source"><ul class="dummy"><li>
1823 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line64">line 64</a>
1824 </li></ul></dd>
1825
1826
1827
1828
1829
1830
1831
1832</dl>
1833
1834
1835
1836
1837
1838
1839
1840
1841<h4 class="name" id="stream"><span class="type-signature"></span>stream<span class="type-signature"></span></h4>
1842
1843
1844
1845
1846<div class="description">
1847 Get a stream reference
1848</div>
1849
1850
1851
1852
1853
1854
1855
1856<dl class="details">
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883 <dt class="tag-source">Source:</dt>
1884 <dd class="tag-source"><ul class="dummy"><li>
1885 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line64">line 64</a>
1886 </li></ul></dd>
1887
1888
1889
1890
1891
1892
1893
1894</dl>
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905 <h3 class="subsection-title">Methods</h3>
1906
1907
1908
1909
1910
1911
1912 <h4 class="name" id="fromJSON"><span class="type-signature"></span>fromJSON<span class="signature">()</span><span class="type-signature"></span></h4>
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930<dl class="details">
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957 <dt class="tag-source">Source:</dt>
1958 <dd class="tag-source"><ul class="dummy"><li>
1959 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line23">line 23</a>
1960 </li></ul></dd>
1961
1962
1963
1964
1965
1966
1967
1968</dl>
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990 <h4 class="name" id="fromJSON"><span class="type-signature"></span>fromJSON<span class="signature">()</span><span class="type-signature"></span></h4>
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008<dl class="details">
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035 <dt class="tag-source">Source:</dt>
2036 <dd class="tag-source"><ul class="dummy"><li>
2037 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line23">line 23</a>
2038 </li></ul></dd>
2039
2040
2041
2042
2043
2044
2045
2046</dl>
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068 <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(idx)</span><span class="type-signature"> &rarr; {<a href="RecordSet.html">RecordSet</a>}</span></h4>
2069
2070
2071
2072
2073
2074<div class="description">
2075 Return a RecordSet at the specified index if available
2076</div>
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086 <h5>Parameters:</h5>
2087
2088
2089<table class="params">
2090 <thead>
2091 <tr>
2092
2093 <th>Name</th>
2094
2095
2096 <th>Type</th>
2097
2098
2099
2100
2101
2102 <th class="last">Description</th>
2103 </tr>
2104 </thead>
2105
2106 <tbody>
2107
2108
2109 <tr>
2110
2111 <td class="name"><code>idx</code></td>
2112
2113
2114 <td class="type">
2115
2116
2117<span class="param-type">Number</span>
2118
2119
2120
2121 </td>
2122
2123
2124
2125
2126
2127 <td class="description last">Index position</td>
2128 </tr>
2129
2130
2131 </tbody>
2132</table>
2133
2134
2135
2136
2137
2138
2139<dl class="details">
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166 <dt class="tag-source">Source:</dt>
2167 <dd class="tag-source"><ul class="dummy"><li>
2168 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line73">line 73</a>
2169 </li></ul></dd>
2170
2171
2172
2173
2174
2175
2176
2177</dl>
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191<h5>Returns:</h5>
2192
2193
2194<div class="param-desc">
2195 record record object
2196</div>
2197
2198
2199
2200<dl>
2201 <dt>
2202 Type
2203 </dt>
2204 <dd>
2205
2206<span class="param-type"><a href="RecordSet.html">RecordSet</a></span>
2207
2208
2209 </dd>
2210</dl>
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221 <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(idx)</span><span class="type-signature"> &rarr; {<a href="RecordSet.html">RecordSet</a>}</span></h4>
2222
2223
2224
2225
2226
2227<div class="description">
2228 Return a RecordSet at the specified index if available
2229</div>
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239 <h5>Parameters:</h5>
2240
2241
2242<table class="params">
2243 <thead>
2244 <tr>
2245
2246 <th>Name</th>
2247
2248
2249 <th>Type</th>
2250
2251
2252
2253
2254
2255 <th class="last">Description</th>
2256 </tr>
2257 </thead>
2258
2259 <tbody>
2260
2261
2262 <tr>
2263
2264 <td class="name"><code>idx</code></td>
2265
2266
2267 <td class="type">
2268
2269
2270<span class="param-type">Number</span>
2271
2272
2273
2274 </td>
2275
2276
2277
2278
2279
2280 <td class="description last">Index position</td>
2281 </tr>
2282
2283
2284 </tbody>
2285</table>
2286
2287
2288
2289
2290
2291
2292<dl class="details">
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319 <dt class="tag-source">Source:</dt>
2320 <dd class="tag-source"><ul class="dummy"><li>
2321 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line73">line 73</a>
2322 </li></ul></dd>
2323
2324
2325
2326
2327
2328
2329
2330</dl>
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344<h5>Returns:</h5>
2345
2346
2347<div class="param-desc">
2348 record record object
2349</div>
2350
2351
2352
2353<dl>
2354 <dt>
2355 Type
2356 </dt>
2357 <dd>
2358
2359<span class="param-type"><a href="RecordSet.html">RecordSet</a></span>
2360
2361
2362 </dd>
2363</dl>
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374 <h4 class="name" id="setStream"><span class="type-signature"></span>setStream<span class="signature">(stream)</span><span class="type-signature"></span></h4>
2375
2376
2377
2378
2379
2380<div class="description">
2381 Set a stream reference
2382</div>
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392 <h5>Parameters:</h5>
2393
2394
2395<table class="params">
2396 <thead>
2397 <tr>
2398
2399 <th>Name</th>
2400
2401
2402 <th>Type</th>
2403
2404
2405
2406
2407
2408 <th class="last">Description</th>
2409 </tr>
2410 </thead>
2411
2412 <tbody>
2413
2414
2415 <tr>
2416
2417 <td class="name"><code>stream</code></td>
2418
2419
2420 <td class="type">
2421
2422
2423<span class="param-type"><a href="Stream.html">Stream</a></span>
2424
2425
2426
2427 </td>
2428
2429
2430
2431
2432
2433 <td class="description last">a stream object reference</td>
2434 </tr>
2435
2436
2437 </tbody>
2438</table>
2439
2440
2441
2442
2443
2444
2445<dl class="details">
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472 <dt class="tag-source">Source:</dt>
2473 <dd class="tag-source"><ul class="dummy"><li>
2474 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line53">line 53</a>
2475 </li></ul></dd>
2476
2477
2478
2479
2480
2481
2482
2483</dl>
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505 <h4 class="name" id="setStream"><span class="type-signature"></span>setStream<span class="signature">(stream)</span><span class="type-signature"></span></h4>
2506
2507
2508
2509
2510
2511<div class="description">
2512 Set a stream reference
2513</div>
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523 <h5>Parameters:</h5>
2524
2525
2526<table class="params">
2527 <thead>
2528 <tr>
2529
2530 <th>Name</th>
2531
2532
2533 <th>Type</th>
2534
2535
2536
2537
2538
2539 <th class="last">Description</th>
2540 </tr>
2541 </thead>
2542
2543 <tbody>
2544
2545
2546 <tr>
2547
2548 <td class="name"><code>stream</code></td>
2549
2550
2551 <td class="type">
2552
2553
2554<span class="param-type"><a href="Stream.html">Stream</a></span>
2555
2556
2557
2558 </td>
2559
2560
2561
2562
2563
2564 <td class="description last">a stream object reference</td>
2565 </tr>
2566
2567
2568 </tbody>
2569</table>
2570
2571
2572
2573
2574
2575
2576<dl class="details">
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603 <dt class="tag-source">Source:</dt>
2604 <dd class="tag-source"><ul class="dummy"><li>
2605 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line53">line 53</a>
2606 </li></ul></dd>
2607
2608
2609
2610
2611
2612
2613
2614</dl>
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636 <h4 class="name" id="size"><span class="type-signature"></span>size<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>
2637
2638
2639
2640
2641
2642<div class="description">
2643 Return the count of available records
2644</div>
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658<dl class="details">
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685 <dt class="tag-source">Source:</dt>
2686 <dd class="tag-source"><ul class="dummy"><li>
2687 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line81">line 81</a>
2688 </li></ul></dd>
2689
2690
2691
2692
2693
2694
2695
2696</dl>
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710<h5>Returns:</h5>
2711
2712
2713<div class="param-desc">
2714 length count of records
2715</div>
2716
2717
2718
2719<dl>
2720 <dt>
2721 Type
2722 </dt>
2723 <dd>
2724
2725<span class="param-type">Number</span>
2726
2727
2728 </dd>
2729</dl>
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740 <h4 class="name" id="size"><span class="type-signature"></span>size<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>
2741
2742
2743
2744
2745
2746<div class="description">
2747 Return the count of available records
2748</div>
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762<dl class="details">
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789 <dt class="tag-source">Source:</dt>
2790 <dd class="tag-source"><ul class="dummy"><li>
2791 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line81">line 81</a>
2792 </li></ul></dd>
2793
2794
2795
2796
2797
2798
2799
2800</dl>
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814<h5>Returns:</h5>
2815
2816
2817<div class="param-desc">
2818 length count of records
2819</div>
2820
2821
2822
2823<dl>
2824 <dt>
2825 Type
2826 </dt>
2827 <dd>
2828
2829<span class="param-type">Number</span>
2830
2831
2832 </dd>
2833</dl>
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844 <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"></span></h4>
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862<dl class="details">
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889 <dt class="tag-source">Source:</dt>
2890 <dd class="tag-source"><ul class="dummy"><li>
2891 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line34">line 34</a>
2892 </li></ul></dd>
2893
2894
2895
2896
2897
2898
2899
2900</dl>
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922 <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"></span></h4>
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940<dl class="details">
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967 <dt class="tag-source">Source:</dt>
2968 <dd class="tag-source"><ul class="dummy"><li>
2969 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line34">line 34</a>
2970 </li></ul></dd>
2971
2972
2973
2974
2975
2976
2977
2978</dl>
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000 <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">()</span><span class="type-signature"></span></h4>
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018<dl class="details">
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045 <dt class="tag-source">Source:</dt>
3046 <dd class="tag-source"><ul class="dummy"><li>
3047 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line43">line 43</a>
3048 </li></ul></dd>
3049
3050
3051
3052
3053
3054
3055
3056</dl>
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078 <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">()</span><span class="type-signature"></span></h4>
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096<dl class="details">
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123 <dt class="tag-source">Source:</dt>
3124 <dd class="tag-source"><ul class="dummy"><li>
3125 <a href="lib_model_ResultSet.js.html">lib/model/ResultSet.js</a>, <a href="lib_model_ResultSet.js.html#line43">line 43</a>
3126 </li></ul></dd>
3127
3128
3129
3130
3131
3132
3133
3134</dl>
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157</article>
3158
3159</section>
3160
3161
3162
3163
3164</div>
3165
3166<nav>
3167 <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Action.html">Action</a></li><li><a href="Channel.html">Channel</a></li><li><a href="Client.html">Client</a></li><li><a href="Raptor.html">Raptor</a></li><li><a href="RecordSet.html">RecordSet</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="ServiceObject.html">ServiceObject</a></li><li><a href="Stream.html">Stream</a></li><li><a href="User.html">User</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Container">Container</a></li></ul>
3168</nav>
3169
3170<br class="clear">
3171
3172<footer>
3173 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Wed Nov 02 2016 11:15:06 GMT+0100 (CET)
3174</footer>
3175
3176<script> prettyPrint(); </script>
3177<script src="scripts/linenumber.js"> </script>
3178</body>
3179</html>
\No newline at end of file