Permalink
Browse files

Updating docs for 1.3.0 release

  • Loading branch information...
1 parent 68ebde1 commit bce923f8f7106d3ae46b6e4724fb09a495cd0dd2 @dima committed Sep 27, 2010
Showing with 877 additions and 184 deletions.
  1. +3 −0 doc/api/all-classes.html
  2. +17 −0 doc/api/all-index-B.html
  3. +33 −4 doc/api/all-index-C.html
  4. +3 −3 doc/api/all-index-D.html
  5. +15 −0 doc/api/all-index-E.html
  6. +10 −2 doc/api/all-index-I.html
  7. +15 −0 doc/api/all-index-J.html
  8. +0 −6 doc/api/all-index-M.html
  9. +8 −0 doc/api/all-index-O.html
  10. +1 −1 doc/api/all-index-R.html
  11. +10 −4 doc/api/all-index-S.html
  12. +11 −5 doc/api/all-index-U.html
  13. +49 −43 doc/api/class-summary.html
  14. +17 −13 doc/api/org/restfulx/components/rx/MoneyTextInput.html
  15. +66 −1 doc/api/org/restfulx/components/rx/RxAutoComplete.html
  16. +86 −17 doc/api/org/restfulx/controllers/AuxAIRController.html
  17. +3 −0 doc/api/org/restfulx/controllers/AuxHTTPController.html
  18. +45 −10 doc/api/org/restfulx/controllers/CacheController.html
  19. +14 −2 doc/api/org/restfulx/controllers/ChangeController.html
  20. +58 −15 doc/api/org/restfulx/controllers/ModelsController.html
  21. +1 −1 doc/api/org/restfulx/controllers/mock/MockAuxHTTPController.html
  22. +23 −3 doc/api/org/restfulx/events/CacheUpdateEvent.html
  23. +1 −1 doc/api/org/restfulx/services/GenericServiceErrors.html
  24. +46 −2 doc/api/org/restfulx/services/ISyncingServiceProvider.html
  25. +167 −0 doc/api/org/restfulx/services/JSONServiceErrors.html
  26. +8 −2 doc/api/org/restfulx/services/ServiceResponder.html
  27. +67 −7 doc/api/org/restfulx/services/air/AIRServiceProvider.html
  28. +3 −0 doc/api/org/restfulx/services/class-list.html
  29. +24 −4 doc/api/org/restfulx/services/mock/MockAIRServiceProvider.html
  30. +6 −2 doc/api/org/restfulx/services/package-detail.html
  31. +67 −36 framework/src/org/restfulx/components/rx/RxAutoComplete.as
@@ -130,6 +130,9 @@
<td><a href="org/restfulx/serializers/JSONSerializer.html">JSONSerializer</a></td>
</tr>
<tr>
+<td><a href="org/restfulx/services/JSONServiceErrors.html">JSONServiceErrors</a></td>
+</tr>
+<tr>
<td><a href="org/restfulx/services/mock/MockAIRServiceProvider.html">MockAIRServiceProvider</a></td>
</tr>
<tr>
@@ -35,6 +35,23 @@
<td colspan="2"><a name="B"></a><a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-A.html">A</a>&nbsp;&nbsp;<font style="bold" size="10px" color="black">B</font>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-C.html">C</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-D.html">D</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-E.html">E</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-F.html">F</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-G.html">G</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-H.html">H</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-I.html">I</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-J.html">J</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-K.html">K</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-L.html">L</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-M.html">M</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-N.html">N</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-O.html">O</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-P.html">P</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-Q.html">Q</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-R.html">R</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-S.html">S</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-T.html">T</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-U.html">U</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-V.html">V</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-W.html">W</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-X.html">X</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-Y.html">Y</a>&nbsp;&nbsp;<a onclick="javascript:loadClassListFrame('index-list.html');" href="all-index-Z.html">Z</a>&nbsp;&nbsp;</td>
</tr>
<tr>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/class-list.html');" href="org/restfulx/services/ISyncingServiceProvider.html#beginTransaction()">beginTransaction</a>() &mdash; Method in interface org.restfulx.services.<a onclick="javascript:loadClassListFrame('org/restfulx/services/class-list.html');" href="org/restfulx/services/ISyncingServiceProvider.html">ISyncingServiceProvider</a></td>
+</tr>
+<tr>
+<td width="20"></td><td>
+ If the service provider supports it, this begins a transaction
+ </td>
+</tr>
+<tr>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/air/class-list.html');" href="org/restfulx/services/air/AIRServiceProvider.html#beginTransaction()">beginTransaction</a>() &mdash; Method in class org.restfulx.services.air.<a onclick="javascript:loadClassListFrame('org/restfulx/services/air/class-list.html');" href="org/restfulx/services/air/AIRServiceProvider.html">AIRServiceProvider</a></td>
+</tr>
+<tr>
+<td width="20"></td><td>
+
+ If the service provider supports it, this begins a transaction
+ </td>
+</tr>
+<tr>
<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/BinaryAttachment.html">BinaryAttachment</a> &mdash; Class in package <a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/package-detail.html">org.restfulx.utils</a></td>
</tr>
<tr>
@@ -73,7 +73,7 @@
used to selectively refresh data providers, etc.</td>
</tr>
<tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/events/class-list.html');" href="org/restfulx/events/CacheUpdateEvent.html#CacheUpdateEvent()">CacheUpdateEvent</a>(fqn, opType, data) &mdash; Constructor in class org.restfulx.events.<a onclick="javascript:loadClassListFrame('org/restfulx/events/class-list.html');" href="org/restfulx/events/CacheUpdateEvent.html">CacheUpdateEvent</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/events/class-list.html');" href="org/restfulx/events/CacheUpdateEvent.html#CacheUpdateEvent()">CacheUpdateEvent</a>(fqn, opType, serviceProvider:<a href="org/restfulx/services/IServiceProvider.html" onclick="javascript:loadClassListFrame('org/restfulx/services./class-list.html');">org.restfulx.services:IServiceProvider</a>, data) &mdash; Constructor in class org.restfulx.events.<a onclick="javascript:loadClassListFrame('org/restfulx/events/class-list.html');" href="org/restfulx/events/CacheUpdateEvent.html">CacheUpdateEvent</a></td>
</tr>
<tr>
<td width="20"></td><td></td>
@@ -177,7 +177,7 @@
Rx.changes to perform synchronization between 2 different service providers.</td>
</tr>
<tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ChangeController.html#ChangeController()">ChangeController</a>(source:<a href="org/restfulx/services/ISyncingServiceProvider.html" onclick="javascript:loadClassListFrame('org/restfulx/services./class-list.html');">org.restfulx.services:ISyncingServiceProvider</a>, destination:<a href="org/restfulx/services/IServiceProvider.html" onclick="javascript:loadClassListFrame('org/restfulx/services./class-list.html');">org.restfulx.services:IServiceProvider</a>) &mdash; Constructor in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ChangeController.html">ChangeController</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ChangeController.html#ChangeController()">ChangeController</a>(source:<a href="org/restfulx/services/ISyncingServiceProvider.html" onclick="javascript:loadClassListFrame('org/restfulx/services./class-list.html');">org.restfulx.services:ISyncingServiceProvider</a>, destination:<a href="org/restfulx/services/IServiceProvider.html" onclick="javascript:loadClassListFrame('org/restfulx/services./class-list.html');">org.restfulx.services:IServiceProvider</a>, onSuccess, onFailure) &mdash; Constructor in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ChangeController.html">ChangeController</a></td>
</tr>
<tr>
<td width="20"></td><td>
@@ -206,6 +206,12 @@
<td width="20"></td><td> exposes the Synchronization capable controller </td>
</tr>
<tr>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html#checkConditions()">checkConditions</a>(source, conditions) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html">AuxAIRController</a></td>
+</tr>
+<tr>
+<td width="20"></td><td></td>
+</tr>
+<tr>
<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/serializers/class-list.html');" href="org/restfulx/serializers/GenericSerializer.html#checkConditions()">checkConditions</a>(source, conditions) &mdash; Method in class org.restfulx.serializers.<a onclick="javascript:loadClassListFrame('org/restfulx/serializers/class-list.html');" href="org/restfulx/serializers/GenericSerializer.html">GenericSerializer</a></td>
</tr>
<tr>
@@ -344,6 +350,23 @@
<td width="20"></td><td></td>
</tr>
<tr>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/class-list.html');" href="org/restfulx/services/ISyncingServiceProvider.html#commitTransaction()">commitTransaction</a>(responder) &mdash; Method in interface org.restfulx.services.<a onclick="javascript:loadClassListFrame('org/restfulx/services/class-list.html');" href="org/restfulx/services/ISyncingServiceProvider.html">ISyncingServiceProvider</a></td>
+</tr>
+<tr>
+<td width="20"></td><td>
+ If the service provider supports it, this commits the currently active transaction
+ </td>
+</tr>
+<tr>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/air/class-list.html');" href="org/restfulx/services/air/AIRServiceProvider.html#commitTransaction()">commitTransaction</a>(responder) &mdash; Method in class org.restfulx.services.air.<a onclick="javascript:loadClassListFrame('org/restfulx/services/air/class-list.html');" href="org/restfulx/services/air/AIRServiceProvider.html">AIRServiceProvider</a></td>
+</tr>
+<tr>
+<td width="20"></td><td>
+
+ If the service provider supports it, this commits the currently active transaction
+ </td>
+</tr>
+<tr>
<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/UUID.html#compare()">compare</a>(aUUID:<a href="org/restfulx/utils/UUID.html" onclick="javascript:loadClassListFrame('org/restfulx/utils./class-list.html');">org.restfulx.utils:UUID</a>) &mdash; Method in class org.restfulx.utils.<a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/UUID.html">UUID</a></td>
</tr>
<tr>
@@ -416,14 +439,14 @@
Root URL for CouchDB requests.</td>
</tr>
<tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/CacheController.html#create()">create</a>(model:<a href="org/restfulx/models/RxModel.html" onclick="javascript:loadClassListFrame('org/restfulx/models./class-list.html');">org.restfulx.models:RxModel</a>) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/CacheController.html">CacheController</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/CacheController.html#create()">create</a>(model:<a href="org/restfulx/models/RxModel.html" onclick="javascript:loadClassListFrame('org/restfulx/models./class-list.html');">org.restfulx.models:RxModel</a>, serviceProvider:<a href="org/restfulx/services/IServiceProvider.html" onclick="javascript:loadClassListFrame('org/restfulx/services./class-list.html');">org.restfulx.services:IServiceProvider</a>) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/CacheController.html">CacheController</a></td>
</tr>
<tr>
<td width="20"></td><td>
Cache version of the <code>create</code> call.</td>
</tr>
<tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ModelsController.html#create()">create</a>(object, optsOrOnSuccess, onFailure, nestedBy, metadata, recursive, targetServiceId, customProcessor) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ModelsController.html">ModelsController</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ModelsController.html#create()">create</a>(object, optsOrOnSuccess, onFailure, nestedBy, metadata, recursive, targetServiceId, customProcessor, unmarshallDisconnected) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ModelsController.html">ModelsController</a></td>
</tr>
<tr>
<td width="20"></td><td>
@@ -535,6 +558,12 @@
Default validation result creator.</td>
</tr>
<tr>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/components/rx/class-list.html');" href="org/restfulx/components/rx/MoneyTextInput.html#currencySymbol">currencySymbol</a> &mdash; Property in class org.restfulx.components.rx.<a onclick="javascript:loadClassListFrame('org/restfulx/components/rx/class-list.html');" href="org/restfulx/components/rx/MoneyTextInput.html">MoneyTextInput</a></td>
+</tr>
+<tr>
+<td width="20"></td><td></td>
+</tr>
+<tr>
<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ServerPushController.html#currentSignature">currentSignature</a> &mdash; Property in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ServerPushController.html">ServerPushController</a></td>
</tr>
<tr>
@@ -135,7 +135,7 @@
this is typically useful with HTTP provider (but may be useful with other providers too).</td>
</tr>
<tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html#defaultResultHandler()">defaultResultHandler</a>(data, token) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html">AuxAIRController</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html#defaultResultHandler()">defaultResultHandler</a>(event, token) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html">AuxAIRController</a></td>
</tr>
<tr>
<td width="20"></td><td></td>
@@ -180,14 +180,14 @@
Gets Resource metadata.</td>
</tr>
<tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/CacheController.html#destroy()">destroy</a>(model:<a href="org/restfulx/models/RxModel.html" onclick="javascript:loadClassListFrame('org/restfulx/models./class-list.html');">org.restfulx.models:RxModel</a>) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/CacheController.html">CacheController</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/CacheController.html#destroy()">destroy</a>(model:<a href="org/restfulx/models/RxModel.html" onclick="javascript:loadClassListFrame('org/restfulx/models./class-list.html');">org.restfulx.models:RxModel</a>, serviceProvider:<a href="org/restfulx/services/IServiceProvider.html" onclick="javascript:loadClassListFrame('org/restfulx/services./class-list.html');">org.restfulx.services:IServiceProvider</a>) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/CacheController.html">CacheController</a></td>
</tr>
<tr>
<td width="20"></td><td>
Cache version of the <code>destroy</code> call.</td>
</tr>
<tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ModelsController.html#destroy()">destroy</a>(object, optsOrOnSuccess, onFailure, nestedBy, metadata, recursive, targetServiceId, customProcessor) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ModelsController.html">ModelsController</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ModelsController.html#destroy()">destroy</a>(object, optsOrOnSuccess, onFailure, nestedBy, metadata, recursive, targetServiceId, customProcessor, unmarshallDisconnected) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ModelsController.html">ModelsController</a></td>
</tr>
<tr>
<td width="20"></td><td>
@@ -64,6 +64,12 @@
is enabled.</td>
</tr>
<tr>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/components/rx/class-list.html');" href="org/restfulx/components/rx/RxAutoComplete.html#enterKeyInvokesSearch">enterKeyInvokesSearch</a> &mdash; Property in class org.restfulx.components.rx.<a onclick="javascript:loadClassListFrame('org/restfulx/components/rx/class-list.html');" href="org/restfulx/components/rx/RxAutoComplete.html">RxAutoComplete</a></td>
+</tr>
+<tr>
+<td width="20"></td><td> If enter key is hit, invoke search </td>
+</tr>
+<tr>
<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/UUID.html#equals()">equals</a>(aUUID:<a href="org/restfulx/utils/UUID.html" onclick="javascript:loadClassListFrame('org/restfulx/utils./class-list.html');">org.restfulx.utils:UUID</a>) &mdash; Method in class org.restfulx.utils.<a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/UUID.html">UUID</a></td>
</tr>
<tr>
@@ -136,6 +142,15 @@
</td>
</tr>
<tr>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html#executeAnySQLInBulk()">executeAnySQLInBulk</a>(optsOrClazz, statements) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html">AuxAIRController</a></td>
+</tr>
+<tr>
+<td width="20"></td><td>
+ This executes any sequence of SQL statements within a trasaction
+
+ </td>
+</tr>
+<tr>
<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html#executePendingSQLStatements()">executePendingSQLStatements</a>() &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html">AuxAIRController</a></td>
</tr>
<tr>
Oops, something went wrong. Retry.

0 comments on commit bce923f

Please sign in to comment.