Merge branch 'timlim/add-scroll' into MM/scroll

Author: mmartinic

README.md

@@ -134,12 +134,17 @@ user = User.find(params);
 user.addCustomAttribute(CustomAttribute.newStringAttribute("role", "captain"));
 User.update(user);
 
-// Iterate over all users
+// Iterate over all users (up to 10k records, to read all use Scroll API)
 UserCollection users = User.list();
 while(users.hasNext()) {
     System.out.println(users.next().getUserId());
 }
 
+// Retrieve users via Scroll API
+ScrollableUserCollection usersScroll = User.scroll();
+List<User> users = usersScroll.getPage();
+usersScroll = usersScroll.scroll();
+
 // Bulk submit users
 final List<JobItem<User>> items = Lists.newArrayList();
 items.add(new JobItem<User>("post", user1));
@@ -187,12 +192,18 @@ while(contacts.hasNext()) {
     System.out.println(contacts.next());
 }
 
-// Iterate over all contacts
+// Iterate over all contacts (up to 10k records, to read all use Scroll API)
 ContactCollection allContacts = Contact.list();
 while(allContacts.hasNext()) {
     System.out.println(allContacts.next());
 }
 
+// Retrieve contacts via Scroll API
+ScrollableContactCollection contactsScroll = Contact.scroll();
+List<Contact> contacts = contactsScroll.getPage();
+contactsScroll = contactsScroll.scroll();
+
+
 // Remove a contact
 Contact.delete(contact);
 
@@ -586,6 +597,8 @@ These return a Collection object (eg `UserCollection`) which can be iterated in
 
 - Java's inbuilt iterator methods `next()` and `hasNext()` - these are useful when you want to fetch data without manually handling pagination.
 
+- User and Contact listing only works up to 10k records. To retrieve all records use the Scroll API via `scroll()`
+
 ### Error handling
 
 You do not need to deal with the HTTP response from an API call directly.