NAME

Usergrid::Collection - Encapsulates collection functionality

DESCRIPTION

Provides support for encapsulating collection data and for iterating through them easily.

ATTRIBUTES

object

A hash reference with the collection data (Read/Write, Required).

METHODS

has_next_entity

Returns true if there's another entity available during iteration.

get_next_entity

Returns the next available entity. Checks to see if there's an entity available to return, and if not returns an undef.

count

Returns the count of the items in the collection.

reset_iterator

Rewinds the iterator back to the beginning.

get_first_entity

Returns the first entity in the collection

get_last_entity

Returns the last entity in the collection

SEE ALSO

Usergrid::Client, Usergrid::Core, Usergrid::Entity, Usergrid::Request

LICENSE

This software is distributed under the Apache 2 license.

AUTHOR

Anuradha Weeraman <anuradha@cpan.org>