quickbooks 0.4.0 → 0.9.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. data.tar.gz.sig +0 -0
  2. data/History.txt +23 -0
  3. data/License.txt +54 -0
  4. data/Manifest.txt +73 -0
  5. data/README.txt +79 -0
  6. data/Rakefile +17 -78
  7. data/lib/quickbooks.rb +153 -7
  8. data/lib/quickbooks/adaptability.rb +67 -0
  9. data/lib/quickbooks/adapters/http_adapter.rb +94 -0
  10. data/lib/quickbooks/adapters/https_adapter.rb +57 -0
  11. data/lib/quickbooks/adapters/ole_adapter.rb +141 -110
  12. data/lib/quickbooks/adapters/spew_adapter.rb +39 -0
  13. data/lib/quickbooks/adapters/tcp_adapter.rb +71 -0
  14. data/lib/quickbooks/adapters/test_adapter.rb +62 -0
  15. data/lib/quickbooks/element.rb +385 -0
  16. data/lib/quickbooks/element_collection.rb +105 -0
  17. data/lib/quickbooks/extlib.rb +8 -0
  18. data/lib/quickbooks/extlib/assertions.rb +8 -0
  19. data/lib/quickbooks/extlib/class.rb +98 -0
  20. data/lib/quickbooks/extlib/days_and_times.rb +10 -0
  21. data/lib/quickbooks/extlib/days_and_times/duration.rb +362 -0
  22. data/lib/quickbooks/extlib/days_and_times/numeric.rb +48 -0
  23. data/lib/quickbooks/extlib/days_and_times/object.rb +19 -0
  24. data/lib/quickbooks/extlib/days_and_times/time.rb +137 -0
  25. data/lib/quickbooks/extlib/hash.rb +327 -0
  26. data/lib/quickbooks/extlib/hook.rb +366 -0
  27. data/lib/quickbooks/extlib/inflection.rb +436 -0
  28. data/lib/quickbooks/extlib/logger.rb +202 -0
  29. data/lib/quickbooks/extlib/object.rb +162 -0
  30. data/lib/quickbooks/extlib/pathname.rb +15 -0
  31. data/lib/quickbooks/extlib/rubygems.rb +38 -0
  32. data/lib/quickbooks/extlib/string.rb +32 -0
  33. data/lib/quickbooks/extlib/time.rb +41 -0
  34. data/lib/quickbooks/model.rb +503 -121
  35. data/lib/quickbooks/option.rb +95 -0
  36. data/lib/quickbooks/property.rb +69 -0
  37. data/lib/quickbooks/ruby_ext.rb +251 -0
  38. data/lib/quickbooks/type.rb +75 -0
  39. data/lib/quickbooks/types.rb +58 -0
  40. data/lib/quickbooks/version.rb +10 -0
  41. data/lib/quickbooks/xsd.rb +243 -0
  42. data/lib/quickbooks/xsd/attribute.rb +57 -0
  43. data/lib/quickbooks/xsd/choice.rb +94 -0
  44. data/lib/quickbooks/xsd/complex_type.rb +77 -0
  45. data/lib/quickbooks/xsd/element.rb +214 -0
  46. data/lib/quickbooks/xsd/group.rb +94 -0
  47. data/lib/quickbooks/xsd/restriction.rb +51 -0
  48. data/lib/quickbooks/xsd/sequence.rb +85 -0
  49. data/lib/quickbooks/xsd/simple_type.rb +87 -0
  50. data/lib/quickbooks/xsd/union.rb +70 -0
  51. data/lib/quickbooks/xsd/validation.rb +89 -0
  52. data/lib/quickbooks/xsd/xml_parse.rb +80 -0
  53. data/quickbooks.gemspec +36 -0
  54. data/source/qbxml21_demo.xsd +2223 -0
  55. data/source/qbxmlops_demo.xsd +483 -0
  56. data/source/qbxmltypes.xsd +160 -0
  57. data/spec/association_spec.rb +5 -0
  58. data/spec/element_collection_spec.rb +8 -0
  59. data/spec/find_spec.rb +30 -0
  60. data/spec/lib/quickbooks/element_spec.rb +83 -0
  61. data/spec/lib/quickbooks/elements/sales_order_add_spec.rb +14 -0
  62. data/spec/lib/quickbooks/elements/vendor_add_spec.rb +78 -0
  63. data/spec/lib/quickbooks/model_spec.rb +89 -0
  64. data/spec/lib/quickbooks/models/customer_spec.rb +52 -0
  65. data/spec/lib/quickbooks/models/invoice_spec.rb +12 -0
  66. data/spec/lib/quickbooks/models/sales_order_line_spec.rb +0 -0
  67. data/spec/lib/quickbooks/models/sales_order_spec.rb +145 -0
  68. data/spec/lib/quickbooks/xsd/choice_spec.rb +18 -0
  69. data/spec/pending_spec.rb +11 -0
  70. data/spec/quickbooks_spec.rb +38 -0
  71. data/spec/repeatable_spec.rb +20 -0
  72. data/spec/requires_spec.rb +10 -0
  73. data/spec/spec_helper.rb +5 -0
  74. data/spec/validation_spec.rb +24 -0
  75. metadata +133 -285
  76. metadata.gz.sig +0 -0
  77. data/LICENSE +0 -16
  78. data/README +0 -49
  79. data/doc/classes/Array.html +0 -368
  80. data/doc/classes/Array.src/M000026.html +0 -18
  81. data/doc/classes/Array.src/M000027.html +0 -21
  82. data/doc/classes/Array.src/M000028.html +0 -18
  83. data/doc/classes/Array.src/M000029.html +0 -19
  84. data/doc/classes/Array.src/M000030.html +0 -18
  85. data/doc/classes/Array.src/M000031.html +0 -23
  86. data/doc/classes/Array.src/M000032.html +0 -18
  87. data/doc/classes/Array.src/M000033.html +0 -18
  88. data/doc/classes/Array.src/M000034.html +0 -18
  89. data/doc/classes/Array.src/M000035.html +0 -19
  90. data/doc/classes/Array.src/M000036.html +0 -18
  91. data/doc/classes/Array.src/M000037.html +0 -23
  92. data/doc/classes/Array.src/M000038.html +0 -18
  93. data/doc/classes/Array.src/M000039.html +0 -21
  94. data/doc/classes/Array.src/M000040.html +0 -18
  95. data/doc/classes/Array.src/M000041.html +0 -18
  96. data/doc/classes/Class.html +0 -171
  97. data/doc/classes/Class.src/M000042.html +0 -18
  98. data/doc/classes/Class.src/M000043.html +0 -18
  99. data/doc/classes/Hash.html +0 -516
  100. data/doc/classes/Hash.src/M000001.html +0 -18
  101. data/doc/classes/Hash.src/M000002.html +0 -21
  102. data/doc/classes/Hash.src/M000003.html +0 -18
  103. data/doc/classes/Hash.src/M000004.html +0 -21
  104. data/doc/classes/Hash.src/M000005.html +0 -18
  105. data/doc/classes/Hash.src/M000006.html +0 -20
  106. data/doc/classes/Hash.src/M000007.html +0 -18
  107. data/doc/classes/Hash.src/M000008.html +0 -22
  108. data/doc/classes/Hash.src/M000009.html +0 -18
  109. data/doc/classes/Hash.src/M000010.html +0 -21
  110. data/doc/classes/Hash.src/M000011.html +0 -24
  111. data/doc/classes/Hash.src/M000012.html +0 -18
  112. data/doc/classes/Hash.src/M000013.html +0 -21
  113. data/doc/classes/Hash.src/M000014.html +0 -18
  114. data/doc/classes/Hash.src/M000015.html +0 -21
  115. data/doc/classes/Hash.src/M000016.html +0 -18
  116. data/doc/classes/Hash.src/M000017.html +0 -21
  117. data/doc/classes/Hash.src/M000018.html +0 -27
  118. data/doc/classes/Hash.src/M000019.html +0 -20
  119. data/doc/classes/Hash.src/M000020.html +0 -18
  120. data/doc/classes/Hash.src/M000021.html +0 -18
  121. data/doc/classes/Hash.src/M000022.html +0 -18
  122. data/doc/classes/Hash.src/M000023.html +0 -18
  123. data/doc/classes/Hash.src/M000024.html +0 -18
  124. data/doc/classes/Hash.src/M000025.html +0 -28
  125. data/doc/classes/Object.html +0 -278
  126. data/doc/classes/Object.src/M000044.html +0 -24
  127. data/doc/classes/Object.src/M000045.html +0 -19
  128. data/doc/classes/Object.src/M000046.html +0 -24
  129. data/doc/classes/Object.src/M000047.html +0 -18
  130. data/doc/classes/Object.src/M000048.html +0 -19
  131. data/doc/classes/Object.src/M000049.html +0 -18
  132. data/doc/classes/Object.src/M000050.html +0 -18
  133. data/doc/classes/Object.src/M000051.html +0 -18
  134. data/doc/classes/Qbxml.html +0 -131
  135. data/doc/classes/Qbxml/Request.html +0 -224
  136. data/doc/classes/Qbxml/Request.src/M000132.html +0 -66
  137. data/doc/classes/Qbxml/Request.src/M000133.html +0 -19
  138. data/doc/classes/Qbxml/Request.src/M000134.html +0 -83
  139. data/doc/classes/Qbxml/RequestSet.html +0 -199
  140. data/doc/classes/Qbxml/RequestSet.src/M000135.html +0 -22
  141. data/doc/classes/Qbxml/RequestSet.src/M000136.html +0 -26
  142. data/doc/classes/Qbxml/RequestSet.src/M000137.html +0 -18
  143. data/doc/classes/Qbxml/RequestSet.src/M000138.html +0 -22
  144. data/doc/classes/Qbxml/Response.html +0 -302
  145. data/doc/classes/Qbxml/Response.src/M000123.html +0 -24
  146. data/doc/classes/Qbxml/Response.src/M000124.html +0 -19
  147. data/doc/classes/Qbxml/Response.src/M000125.html +0 -55
  148. data/doc/classes/Qbxml/Response.src/M000126.html +0 -18
  149. data/doc/classes/Qbxml/Response.src/M000127.html +0 -18
  150. data/doc/classes/Qbxml/Response.src/M000128.html +0 -18
  151. data/doc/classes/Qbxml/Response.src/M000129.html +0 -18
  152. data/doc/classes/Qbxml/Response.src/M000130.html +0 -18
  153. data/doc/classes/Qbxml/Response.src/M000131.html +0 -63
  154. data/doc/classes/Qbxml/ResponseSet.html +0 -244
  155. data/doc/classes/Qbxml/ResponseSet.src/M000116.html +0 -22
  156. data/doc/classes/Qbxml/ResponseSet.src/M000117.html +0 -26
  157. data/doc/classes/Qbxml/ResponseSet.src/M000118.html +0 -24
  158. data/doc/classes/Qbxml/ResponseSet.src/M000119.html +0 -20
  159. data/doc/classes/Qbxml/ResponseSet.src/M000120.html +0 -27
  160. data/doc/classes/Qbxml/ResponseSet.src/M000121.html +0 -18
  161. data/doc/classes/Qbxml/ResponseSet.src/M000122.html +0 -18
  162. data/doc/classes/Quickbooks.html +0 -196
  163. data/doc/classes/Quickbooks/Address.html +0 -139
  164. data/doc/classes/Quickbooks/Address.src/M000115.html +0 -19
  165. data/doc/classes/Quickbooks/Base.html +0 -567
  166. data/doc/classes/Quickbooks/Base.src/M000095.html +0 -18
  167. data/doc/classes/Quickbooks/Base.src/M000096.html +0 -20
  168. data/doc/classes/Quickbooks/Base.src/M000097.html +0 -19
  169. data/doc/classes/Quickbooks/Base.src/M000098.html +0 -18
  170. data/doc/classes/Quickbooks/Base.src/M000099.html +0 -19
  171. data/doc/classes/Quickbooks/Base.src/M000100.html +0 -30
  172. data/doc/classes/Quickbooks/Base.src/M000101.html +0 -22
  173. data/doc/classes/Quickbooks/Base.src/M000102.html +0 -30
  174. data/doc/classes/Quickbooks/Base.src/M000103.html +0 -19
  175. data/doc/classes/Quickbooks/Base.src/M000104.html +0 -19
  176. data/doc/classes/Quickbooks/Base.src/M000105.html +0 -18
  177. data/doc/classes/Quickbooks/Base.src/M000106.html +0 -18
  178. data/doc/classes/Quickbooks/Base.src/M000107.html +0 -19
  179. data/doc/classes/Quickbooks/Base.src/M000108.html +0 -18
  180. data/doc/classes/Quickbooks/Base.src/M000109.html +0 -45
  181. data/doc/classes/Quickbooks/Base.src/M000110.html +0 -18
  182. data/doc/classes/Quickbooks/Base.src/M000111.html +0 -18
  183. data/doc/classes/Quickbooks/Base.src/M000112.html +0 -20
  184. data/doc/classes/Quickbooks/BillAddress.html +0 -113
  185. data/doc/classes/Quickbooks/CreditCardInfo.html +0 -113
  186. data/doc/classes/Quickbooks/Customer.html +0 -113
  187. data/doc/classes/Quickbooks/CustomerTypeRef.html +0 -113
  188. data/doc/classes/Quickbooks/Deleted.html +0 -113
  189. data/doc/classes/Quickbooks/ItemSalesTaxRef.html +0 -113
  190. data/doc/classes/Quickbooks/JobTypeRef.html +0 -113
  191. data/doc/classes/Quickbooks/ListDeleted.html +0 -139
  192. data/doc/classes/Quickbooks/ListDeleted.src/M000114.html +0 -18
  193. data/doc/classes/Quickbooks/ListItem.html +0 -170
  194. data/doc/classes/Quickbooks/ListItem.src/M000093.html +0 -20
  195. data/doc/classes/Quickbooks/ListItem.src/M000094.html +0 -18
  196. data/doc/classes/Quickbooks/Model.html +0 -462
  197. data/doc/classes/Quickbooks/Model.src/M000073.html +0 -24
  198. data/doc/classes/Quickbooks/Model.src/M000074.html +0 -19
  199. data/doc/classes/Quickbooks/Model.src/M000075.html +0 -18
  200. data/doc/classes/Quickbooks/Model.src/M000076.html +0 -18
  201. data/doc/classes/Quickbooks/Model.src/M000077.html +0 -18
  202. data/doc/classes/Quickbooks/Model.src/M000078.html +0 -22
  203. data/doc/classes/Quickbooks/Model.src/M000079.html +0 -32
  204. data/doc/classes/Quickbooks/Model.src/M000080.html +0 -32
  205. data/doc/classes/Quickbooks/Model.src/M000081.html +0 -18
  206. data/doc/classes/Quickbooks/Model.src/M000082.html +0 -18
  207. data/doc/classes/Quickbooks/Model.src/M000083.html +0 -22
  208. data/doc/classes/Quickbooks/Model.src/M000084.html +0 -23
  209. data/doc/classes/Quickbooks/Model.src/M000085.html +0 -18
  210. data/doc/classes/Quickbooks/Model.src/M000086.html +0 -21
  211. data/doc/classes/Quickbooks/Model.src/M000087.html +0 -26
  212. data/doc/classes/Quickbooks/Model.src/M000088.html +0 -26
  213. data/doc/classes/Quickbooks/Model.src/M000089.html +0 -26
  214. data/doc/classes/Quickbooks/Model.src/M000090.html +0 -21
  215. data/doc/classes/Quickbooks/Model.src/M000091.html +0 -23
  216. data/doc/classes/Quickbooks/OleAdapter.html +0 -129
  217. data/doc/classes/Quickbooks/OleAdapter/Connection.html +0 -343
  218. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000058.html +0 -18
  219. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000059.html +0 -19
  220. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000060.html +0 -24
  221. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000061.html +0 -18
  222. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000062.html +0 -18
  223. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000063.html +0 -21
  224. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000064.html +0 -24
  225. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000065.html +0 -20
  226. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000066.html +0 -24
  227. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000067.html +0 -24
  228. data/doc/classes/Quickbooks/OleAdapter/Ole.html +0 -209
  229. data/doc/classes/Quickbooks/OleAdapter/Ole.src/M000068.html +0 -21
  230. data/doc/classes/Quickbooks/OleAdapter/Ole.src/M000069.html +0 -22
  231. data/doc/classes/Quickbooks/OleAdapter/Ole.src/M000070.html +0 -18
  232. data/doc/classes/Quickbooks/ParentRef.html +0 -113
  233. data/doc/classes/Quickbooks/PreferredPaymentMethodRef.html +0 -113
  234. data/doc/classes/Quickbooks/PriceLevelRef.html +0 -113
  235. data/doc/classes/Quickbooks/QbxmlDebugAdapter.html +0 -111
  236. data/doc/classes/Quickbooks/QbxmlDebugAdapter/Connection.html +0 -139
  237. data/doc/classes/Quickbooks/QbxmlDebugAdapter/Connection.src/M000057.html +0 -18
  238. data/doc/classes/Quickbooks/Ref.html +0 -146
  239. data/doc/classes/Quickbooks/Ref.src/M000113.html +0 -18
  240. data/doc/classes/Quickbooks/SalesRepRef.html +0 -113
  241. data/doc/classes/Quickbooks/SalesTaxCodeRef.html +0 -113
  242. data/doc/classes/Quickbooks/ShipAddress.html +0 -113
  243. data/doc/classes/Quickbooks/TermsRef.html +0 -113
  244. data/doc/classes/Quickbooks/Transaction.html +0 -154
  245. data/doc/classes/Quickbooks/Transaction.src/M000071.html +0 -19
  246. data/doc/classes/Quickbooks/Transaction.src/M000072.html +0 -18
  247. data/doc/classes/Quickbooks/TxnDeleted.html +0 -139
  248. data/doc/classes/Quickbooks/TxnDeleted.src/M000092.html +0 -18
  249. data/doc/classes/String.html +0 -203
  250. data/doc/classes/String.src/M000052.html +0 -18
  251. data/doc/classes/String.src/M000053.html +0 -18
  252. data/doc/classes/String.src/M000054.html +0 -18
  253. data/doc/classes/String.src/M000055.html +0 -18
  254. data/doc/classes/String.src/M000056.html +0 -18
  255. data/doc/created.rid +0 -1
  256. data/doc/files/LICENSE.html +0 -129
  257. data/doc/files/README.html +0 -225
  258. data/doc/files/lib/qbxml/request_rb.html +0 -110
  259. data/doc/files/lib/qbxml/response_rb.html +0 -109
  260. data/doc/files/lib/qbxml/support_rb.html +0 -101
  261. data/doc/files/lib/qbxml_rb.html +0 -122
  262. data/doc/files/lib/quickbooks/adapters/ole_adapter_rb.html +0 -108
  263. data/doc/files/lib/quickbooks/adapters/qbxml_debug_adapter_rb.html +0 -108
  264. data/doc/files/lib/quickbooks/base_rb.html +0 -327
  265. data/doc/files/lib/quickbooks/model_rb.html +0 -108
  266. data/doc/files/lib/quickbooks/models/common/address_rb.html +0 -101
  267. data/doc/files/lib/quickbooks/models/common/all_refs_rb.html +0 -101
  268. data/doc/files/lib/quickbooks/models/customer/credit_card_info_rb.html +0 -101
  269. data/doc/files/lib/quickbooks/models/customer_rb.html +0 -110
  270. data/doc/files/lib/quickbooks/models/deleted_rb.html +0 -101
  271. data/doc/files/lib/quickbooks/models/list_item_rb.html +0 -101
  272. data/doc/files/lib/quickbooks/models/transaction_rb.html +0 -101
  273. data/doc/files/lib/quickbooks/ruby_magic_rb.html +0 -120
  274. data/doc/files/lib/quickbooks_rb.html +0 -125
  275. data/doc/fr_class_index.html +0 -64
  276. data/doc/fr_file_index.html +0 -45
  277. data/doc/fr_method_index.html +0 -164
  278. data/doc/index.html +0 -24
  279. data/doc/rdoc-style.css +0 -208
  280. data/lib/qbxml.rb +0 -3
  281. data/lib/qbxml/request.rb +0 -207
  282. data/lib/qbxml/response.rb +0 -197
  283. data/lib/qbxml/support.rb +0 -130
  284. data/lib/quickbooks/adapters/qbxml_debug_adapter.rb +0 -10
  285. data/lib/quickbooks/base.rb +0 -277
  286. data/lib/quickbooks/models/common/address.rb +0 -14
  287. data/lib/quickbooks/models/common/all_refs.rb +0 -37
  288. data/lib/quickbooks/models/customer.rb +0 -70
  289. data/lib/quickbooks/models/customer/credit_card_info.rb +0 -5
  290. data/lib/quickbooks/models/deleted.rb +0 -22
  291. data/lib/quickbooks/models/list_item.rb +0 -41
  292. data/lib/quickbooks/models/transaction.rb +0 -49
  293. data/lib/quickbooks/ruby_magic.rb +0 -213
@@ -1,20 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html>
7
- <head>
8
- <title>inherited (Quickbooks::ListItem)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/quickbooks/models/list_item.rb, line 12</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
15
- <span class="ruby-keyword kw">super</span>
16
- <span class="ruby-comment cmt"># :time_deleted only comes from ListDeleted, but that way all ListDeleted attributes can be instantiated into the respective ListItem model</span>
17
- <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">read_only</span> <span class="ruby-identifier">:list_id</span>, <span class="ruby-identifier">:full_name</span>, <span class="ruby-identifier">:edit_sequence</span>, <span class="ruby-identifier">:time_created</span>, <span class="ruby-identifier">:time_modified</span>, <span class="ruby-identifier">:time_deleted</span>
18
- <span class="ruby-keyword kw">end</span></pre>
19
- </body>
20
- </html>
@@ -1,18 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html>
7
- <head>
8
- <title>ListOrTxn (Quickbooks::ListItem)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/quickbooks/models/list_item.rb, line 19</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-constant">ListOrTxn</span>
15
- <span class="ruby-value str">'List'</span>
16
- <span class="ruby-keyword kw">end</span></pre>
17
- </body>
18
- </html>
@@ -1,462 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Class: Quickbooks::Model</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Class</strong></td>
53
- <td class="class-name-in-header">Quickbooks::Model</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../../files/lib/quickbooks/model_rb.html">
59
- lib/quickbooks/model.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- <tr class="top-aligned-row">
66
- <td><strong>Parent:</strong></td>
67
- <td>
68
- <a href="../Object.html">
69
- Object
70
- </a>
71
- </td>
72
- </tr>
73
- </table>
74
- </div>
75
- <!-- banner header -->
76
-
77
- <div id="bodyContent">
78
-
79
-
80
-
81
- <div id="contextContent">
82
-
83
-
84
-
85
- </div>
86
-
87
- <div id="method-list">
88
- <h3 class="section-bar">Methods</h3>
89
-
90
- <div class="name-list">
91
- <a href="#M000090">==</a>&nbsp;&nbsp;
92
- <a href="#M000091">===</a>&nbsp;&nbsp;
93
- <a href="#M000083">attributes</a>&nbsp;&nbsp;
94
- <a href="#M000084">attributes=</a>&nbsp;&nbsp;
95
- <a href="#M000078">camelized_valid_filters</a>&nbsp;&nbsp;
96
- <a href="#M000086">dirty?</a>&nbsp;&nbsp;
97
- <a href="#M000087">dirty_attributes</a>&nbsp;&nbsp;
98
- <a href="#M000077">filter_aliases</a>&nbsp;&nbsp;
99
- <a href="#M000076">filter_aliases=</a>&nbsp;&nbsp;
100
- <a href="#M000073">inherited</a>&nbsp;&nbsp;
101
- <a href="#M000082">new</a>&nbsp;&nbsp;
102
- <a href="#M000085">original_values</a>&nbsp;&nbsp;
103
- <a href="#M000081">properties</a>&nbsp;&nbsp;
104
- <a href="#M000080">read_only</a>&nbsp;&nbsp;
105
- <a href="#M000079">read_write</a>&nbsp;&nbsp;
106
- <a href="#M000088">to_dirty_hash</a>&nbsp;&nbsp;
107
- <a href="#M000089">to_hash</a>&nbsp;&nbsp;
108
- <a href="#M000075">valid_filters</a>&nbsp;&nbsp;
109
- <a href="#M000074">valid_filters=</a>&nbsp;&nbsp;
110
- </div>
111
- </div>
112
-
113
- </div>
114
-
115
-
116
- <!-- if includes -->
117
-
118
- <div id="section">
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
- <!-- if method_list -->
128
- <div id="methods">
129
- <h3 class="section-bar">Public Class methods</h3>
130
-
131
- <div id="method-M000078" class="method-detail">
132
- <a name="M000078"></a>
133
-
134
- <div class="method-heading">
135
- <a href="Model.src/M000078.html" target="Code" class="method-signature"
136
- onclick="popupCode('Model.src/M000078.html');return false;">
137
- <span class="method-name">camelized_valid_filters</span><span class="method-args">()</span>
138
- </a>
139
- </div>
140
-
141
- <div class="method-description">
142
- </div>
143
- </div>
144
-
145
- <div id="method-M000077" class="method-detail">
146
- <a name="M000077"></a>
147
-
148
- <div class="method-heading">
149
- <a href="Model.src/M000077.html" target="Code" class="method-signature"
150
- onclick="popupCode('Model.src/M000077.html');return false;">
151
- <span class="method-name">filter_aliases</span><span class="method-args">()</span>
152
- </a>
153
- </div>
154
-
155
- <div class="method-description">
156
- </div>
157
- </div>
158
-
159
- <div id="method-M000076" class="method-detail">
160
- <a name="M000076"></a>
161
-
162
- <div class="method-heading">
163
- <a href="Model.src/M000076.html" target="Code" class="method-signature"
164
- onclick="popupCode('Model.src/M000076.html');return false;">
165
- <span class="method-name">filter_aliases=</span><span class="method-args">(v)</span>
166
- </a>
167
- </div>
168
-
169
- <div class="method-description">
170
- </div>
171
- </div>
172
-
173
- <div id="method-M000073" class="method-detail">
174
- <a name="M000073"></a>
175
-
176
- <div class="method-heading">
177
- <a href="Model.src/M000073.html" target="Code" class="method-signature"
178
- onclick="popupCode('Model.src/M000073.html');return false;">
179
- <span class="method-name">inherited</span><span class="method-args">(klass)</span>
180
- </a>
181
- </div>
182
-
183
- <div class="method-description">
184
- </div>
185
- </div>
186
-
187
- <div id="method-M000082" class="method-detail">
188
- <a name="M000082"></a>
189
-
190
- <div class="method-heading">
191
- <a href="Model.src/M000082.html" target="Code" class="method-signature"
192
- onclick="popupCode('Model.src/M000082.html');return false;">
193
- <span class="method-name">new</span><span class="method-args">(args={})</span>
194
- </a>
195
- </div>
196
-
197
- <div class="method-description">
198
- <p>
199
- The default for all subclasses is simply to apply the <a
200
- href="Model.html#M000083">attributes</a> given, and mark the object as a
201
- new_record?
202
- </p>
203
- </div>
204
- </div>
205
-
206
- <div id="method-M000081" class="method-detail">
207
- <a name="M000081"></a>
208
-
209
- <div class="method-heading">
210
- <a href="Model.src/M000081.html" target="Code" class="method-signature"
211
- onclick="popupCode('Model.src/M000081.html');return false;">
212
- <span class="method-name">properties</span><span class="method-args">()</span>
213
- </a>
214
- </div>
215
-
216
- <div class="method-description">
217
- </div>
218
- </div>
219
-
220
- <div id="method-M000080" class="method-detail">
221
- <a name="M000080"></a>
222
-
223
- <div class="method-heading">
224
- <a href="Model.src/M000080.html" target="Code" class="method-signature"
225
- onclick="popupCode('Model.src/M000080.html');return false;">
226
- <span class="method-name">read_only</span><span class="method-args">(*args)</span>
227
- </a>
228
- </div>
229
-
230
- <div class="method-description">
231
- <p>
232
- Read-only <a href="Model.html#M000083">attributes</a>: These are <a
233
- href="Model.html#M000083">attributes</a>, but not modifiable in <a
234
- href="../Quickbooks.html">Quickbooks</a>
235
- </p>
236
- </div>
237
- </div>
238
-
239
- <div id="method-M000079" class="method-detail">
240
- <a name="M000079"></a>
241
-
242
- <div class="method-heading">
243
- <a href="Model.src/M000079.html" target="Code" class="method-signature"
244
- onclick="popupCode('Model.src/M000079.html');return false;">
245
- <span class="method-name">read_write</span><span class="method-args">(*args)</span>
246
- </a>
247
- </div>
248
-
249
- <div class="method-description">
250
- <p>
251
- Register multiple read/writable <a href="Model.html#M000081">properties</a>
252
- at once. For example:
253
- </p>
254
- <pre>
255
- read_write :first_name, :last_name, :phone, :alt_phone
256
- </pre>
257
- <p>
258
- For reference <a href="Model.html#M000083">attributes</a> (like
259
- parent_ref), use <a href="ParentRef.html">ParentRef</a> - a class constant
260
- for that object. <em><a href="Model.html#M000079">read_write</a></em> will
261
- set the property setter and accessor accordingly.
262
- </p>
263
- </div>
264
- </div>
265
-
266
- <div id="method-M000075" class="method-detail">
267
- <a name="M000075"></a>
268
-
269
- <div class="method-heading">
270
- <a href="Model.src/M000075.html" target="Code" class="method-signature"
271
- onclick="popupCode('Model.src/M000075.html');return false;">
272
- <span class="method-name">valid_filters</span><span class="method-args">()</span>
273
- </a>
274
- </div>
275
-
276
- <div class="method-description">
277
- </div>
278
- </div>
279
-
280
- <div id="method-M000074" class="method-detail">
281
- <a name="M000074"></a>
282
-
283
- <div class="method-heading">
284
- <a href="Model.src/M000074.html" target="Code" class="method-signature"
285
- onclick="popupCode('Model.src/M000074.html');return false;">
286
- <span class="method-name">valid_filters=</span><span class="method-args">(v)</span>
287
- </a>
288
- </div>
289
-
290
- <div class="method-description">
291
- </div>
292
- </div>
293
-
294
- <h3 class="section-bar">Public Instance methods</h3>
295
-
296
- <div id="method-M000090" class="method-detail">
297
- <a name="M000090"></a>
298
-
299
- <div class="method-heading">
300
- <a href="Model.src/M000090.html" target="Code" class="method-signature"
301
- onclick="popupCode('Model.src/M000090.html');return false;">
302
- <span class="method-name">==</span><span class="method-args">(other)</span>
303
- </a>
304
- </div>
305
-
306
- <div class="method-description">
307
- </div>
308
- </div>
309
-
310
- <div id="method-M000091" class="method-detail">
311
- <a name="M000091"></a>
312
-
313
- <div class="method-heading">
314
- <a href="Model.src/M000091.html" target="Code" class="method-signature"
315
- onclick="popupCode('Model.src/M000091.html');return false;">
316
- <span class="method-name">===</span><span class="method-args">(other)</span>
317
- </a>
318
- </div>
319
-
320
- <div class="method-description">
321
- </div>
322
- </div>
323
-
324
- <div id="method-M000083" class="method-detail">
325
- <a name="M000083"></a>
326
-
327
- <div class="method-heading">
328
- <a href="Model.src/M000083.html" target="Code" class="method-signature"
329
- onclick="popupCode('Model.src/M000083.html');return false;">
330
- <span class="method-name">attributes</span><span class="method-args">(include_read_only=false)</span>
331
- </a>
332
- </div>
333
-
334
- <div class="method-description">
335
- <p>
336
- Returns a hash that represents all this object&#8216;s <a
337
- href="Model.html#M000083">attributes</a>.
338
- </p>
339
- </div>
340
- </div>
341
-
342
- <div id="method-M000084" class="method-detail">
343
- <a name="M000084"></a>
344
-
345
- <div class="method-heading">
346
- <a href="Model.src/M000084.html" target="Code" class="method-signature"
347
- onclick="popupCode('Model.src/M000084.html');return false;">
348
- <span class="method-name">attributes=</span><span class="method-args">(attrs)</span>
349
- </a>
350
- </div>
351
-
352
- <div class="method-description">
353
- <p>
354
- Updates all <a href="Model.html#M000083">attributes</a> included in
355
- <em>attrs</em> to the values given. The object will now be <a
356
- href="Model.html#M000086">dirty?</a>.
357
- </p>
358
- </div>
359
- </div>
360
-
361
- <div id="method-M000086" class="method-detail">
362
- <a name="M000086"></a>
363
-
364
- <div class="method-heading">
365
- <a href="Model.src/M000086.html" target="Code" class="method-signature"
366
- onclick="popupCode('Model.src/M000086.html');return false;">
367
- <span class="method-name">dirty?</span><span class="method-args">()</span>
368
- </a>
369
- </div>
370
-
371
- <div class="method-description">
372
- <p>
373
- Returns true if any <a href="Model.html#M000083">attributes</a> have
374
- changed since the object was last loaded or updated from <a
375
- href="../Quickbooks.html">Quickbooks</a>.
376
- </p>
377
- </div>
378
- </div>
379
-
380
- <div id="method-M000087" class="method-detail">
381
- <a name="M000087"></a>
382
-
383
- <div class="method-heading">
384
- <a href="Model.src/M000087.html" target="Code" class="method-signature"
385
- onclick="popupCode('Model.src/M000087.html');return false;">
386
- <span class="method-name">dirty_attributes</span><span class="method-args">(compare={})</span>
387
- </a>
388
- </div>
389
-
390
- <div class="method-description">
391
- <p>
392
- Returns a hash of the <a href="Model.html#M000083">attributes</a> and their
393
- (<a href="Model.html#M000082">new</a>) values that have been changed since
394
- the object was last loaded or updated from <a
395
- href="../Quickbooks.html">Quickbooks</a>. If you send in some <a
396
- href="Model.html#M000083">attributes</a>, it will compare to those given
397
- instead of original_attributes.
398
- </p>
399
- </div>
400
- </div>
401
-
402
- <div id="method-M000085" class="method-detail">
403
- <a name="M000085"></a>
404
-
405
- <div class="method-heading">
406
- <a href="Model.src/M000085.html" target="Code" class="method-signature"
407
- onclick="popupCode('Model.src/M000085.html');return false;">
408
- <span class="method-name">original_values</span><span class="method-args">()</span>
409
- </a>
410
- </div>
411
-
412
- <div class="method-description">
413
- <p>
414
- Keeps track of the original values the object had when it was instantiated
415
- from a quickbooks response. <a href="Model.html#M000086">dirty?</a> and <a
416
- href="Model.html#M000087">dirty_attributes</a> compare the current values
417
- with these ones.
418
- </p>
419
- </div>
420
- </div>
421
-
422
- <div id="method-M000088" class="method-detail">
423
- <a name="M000088"></a>
424
-
425
- <div class="method-heading">
426
- <a href="Model.src/M000088.html" target="Code" class="method-signature"
427
- onclick="popupCode('Model.src/M000088.html');return false;">
428
- <span class="method-name">to_dirty_hash</span><span class="method-args">()</span>
429
- </a>
430
- </div>
431
-
432
- <div class="method-description">
433
- </div>
434
- </div>
435
-
436
- <div id="method-M000089" class="method-detail">
437
- <a name="M000089"></a>
438
-
439
- <div class="method-heading">
440
- <a href="Model.src/M000089.html" target="Code" class="method-signature"
441
- onclick="popupCode('Model.src/M000089.html');return false;">
442
- <span class="method-name">to_hash</span><span class="method-args">(include_read_only=false)</span>
443
- </a>
444
- </div>
445
-
446
- <div class="method-description">
447
- </div>
448
- </div>
449
-
450
-
451
- </div>
452
-
453
-
454
- </div>
455
-
456
-
457
- <div id="validator-badges">
458
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
459
- </div>
460
-
461
- </body>
462
- </html>