Class: Harkness::Base::DataContainer

Inherits:

Shale::Mapper

• Object
• Shale::Mapper
• Harkness::Base::DataContainer

Defined in:

lib/harkness/models/base/data_container.rb

Overview

Container class that holds pagination information.

Direct Known Subclasses

CharacterDataContainer, ComicDataContainer, CreatorDataContainer, EventDataContainer, SeriesDataContainer, StoryDataContainer

Instance Attribute Summary

• #count ⇒ Integer readonly

  The total number of results returned by this call.

• #limit ⇒ Integer readonly

  The requested result limit.

• #offset ⇒ Integer readonly

  The requested offset (number of skipped results) of the call.

• #total ⇒ Integer readonly

  The total number of resources available given the current filter set.

Instance Attribute Details

#count ⇒ Integer (readonly)

Returns the total number of results returned by this call.

Returns:

• (Integer) —

  the total number of results returned by this call.

# File 'lib/harkness/models/base/data_container.rb', line 18

attribute :count, Shale::Type::Integer

#limit ⇒ Integer (readonly)

Returns the requested result limit.

Returns:

• (Integer) —

  the requested result limit.

# File 'lib/harkness/models/base/data_container.rb', line 12

attribute :limit, Shale::Type::Integer

#offset ⇒ Integer (readonly)

Returns the requested offset (number of skipped results) of the call.

Returns:

• (Integer) —

  the requested offset (number of skipped results) of the call.

# File 'lib/harkness/models/base/data_container.rb', line 9

attribute :offset, Shale::Type::Integer

#total ⇒ Integer (readonly)

Returns the total number of resources available given the current filter set.

Returns:

• (Integer) —

  the total number of resources available given the current filter set.

# File 'lib/harkness/models/base/data_container.rb', line 15

attribute :total, Shale::Type::Integer