Contents

module Databasedotcom
  # A collection of Sobject or Record objects that holds a single page of results, and understands how to
  # retrieve the next page, if any. Inherits from Array, thus, behaves as an Enumerable.

  class Collection < Array
    attr_reader :total_size, :next_page_url, :previous_page_url, :current_page_url, :client

    # Creates a paginatable collection. You should never need to call this.
    def initialize(client, total_size, next_page_url=nil, previous_page_url=nil, current_page_url=nil) #:nodoc:
      @client = client
      @total_size = total_size
      @next_page_url = next_page_url
      @previous_page_url = previous_page_url
      @current_page_url = current_page_url
    end

    # Does this collection have a next page?
    def next_page?
      !!self.next_page_url
    end

    # Retrieve the next page of this collection.  Returns the new collection, which is an empty collection if no next page exists
    def next_page
      self.next_page? ? @client.next_page(@next_page_url) : Databasedotcom::Collection.new(self.client, 0)
    end

    # Does this collection have a previous page?
    def previous_page?
      !!self.previous_page_url
    end

    # Retrieve the previous page of this collection. Returns the new collection, which is an empty collection if no previous page exists
    def previous_page
      self.previous_page? ? @client.previous_page(@previous_page_url) : Databasedotcom::Collection.new(self.client, 0)
    end
  end
end

Version data entries

35 entries across 35 versions & 5 rubygems

Version	Path
databasedotcom-1.1.7	lib/databasedotcom/collection.rb
databasedotcom-1.1.6	lib/databasedotcom/collection.rb
databasedotcom-1.1.5	lib/databasedotcom/collection.rb
databasedotcom-1.1.4	lib/databasedotcom/collection.rb
databasedotcom-1.1.2	lib/databasedotcom/collection.rb
databasedotcom-1.1.1	lib/databasedotcom/collection.rb
databasedotcom-1.1.0	lib/databasedotcom/collection.rb
databasedotcom-1.0.9	lib/databasedotcom/collection.rb
databasedotcom-1.0.8	lib/databasedotcom/collection.rb
databasedotcom-1.0.7	lib/databasedotcom/collection.rb
databasedotcom-1.0.6	lib/databasedotcom/collection.rb
databasedotcom-1.0.5	lib/databasedotcom/collection.rb
databasedotcom-1.0.3	lib/databasedotcom/collection.rb
databasedotcom-1.0.2	lib/databasedotcom/collection.rb
databasedotcom-1.0.1	lib/databasedotcom/collection.rb