Class: Harkness::Comic

Inherits:

Shale::Mapper

• Object
• Shale::Mapper
• Harkness::Comic

Defined in:

lib/harkness/models/comic.rb

Overview

An individual character.

Instance Attribute Summary

• #characters ⇒ Harkness::CharacterList readonly

  A resource list containing the characters which appear in this comic.

• #collectedIssues ⇒ Array<Harkness::ComicSummary> readonly

  A list of issues collected in this comic (will generally be empty for periodical formats such as "comic" or "magazine").

• #collections ⇒ Array<Harkness::ComicSummary> readonly

  A list of collections which include this comic (will generally be empty if the comic's format is a collection).

• #creators ⇒ Harkness::CreatorList readonly

  A resource list containing the creators associated with this comic.

• #dates ⇒ Array<Harkness::ComicDate] a list of key dates for this comic. readonly

  Array<Harkness::ComicDate] a list of key dates for this comic.

• #description ⇒ String readonly

  The preferred description of the comic.

• #diamondCode ⇒ String readonly

  The Diamond code for the comic.

• #digitalId ⇒ Integer readonly

  The ID of the digital comic representation of this comic.

• #ean ⇒ String readonly

  The EAN barcode for the comic.

• #events ⇒ Harkness::EventList readonly

  A resource list containing the events in which this comic appears.

• #format ⇒ String readonly

  The publication format of the comic e.g.

• #id ⇒ Integer readonly

  The unique ID of the comic resource.

• #images ⇒ Array<Harkness::Image> readonly

  A list of promotional images associated with this comic.

• #isbn ⇒ String readonly

  The ISBN for the comic (generally only populated for collection formats).

• #issn ⇒ String readonly

  The ISSN barcode for the comic.

• #issueNumber ⇒ Integer readonly

  The number of the issue in the series (will generally be 0 for collection formats).

• #modified ⇒ String readonly

  The date the resource was most recently modified.

• #pageCount ⇒ Integer readonly

  The number of story pages in the comic.

• #prices ⇒ Array<Harkness::ComicPrice> readonly

  A list of prices for this comic.

• #resourceURI ⇒ String readonly

  The canonical URL identifier for this resource.

• #series ⇒ Array<Harkness::SeriesSummary> readonly

  A summary representation of the series to which this comic belongs.

• #stories ⇒ Harkness::StoryList readonly

  A resource list containing the stories which appear in this comic.

• #textObjects ⇒ Array<Harkness::TextObject> readonly

  A set of descriptive text blurbs for the comic.

• #thumbnail ⇒ Harkness::Image readonly

  The representative image for this comic.

• #title ⇒ String readonly

  The canonical title of the comic.

• #upc ⇒ String readonly

  The UPC barcode number for the comic (generally only populated for periodical formats).

• #urls ⇒ Array<Harkness::URL> readonly

  A set of public web site URLs for the resource.

• #variantDescription ⇒ String readonly

  If the issue is a variant (e.g. an alternate cover, second printing, or director’s cut), a text description of the variant.

• #variants ⇒ Array<Harkness::ComicSummary> readonly

  A list of variant issues for this comic (includes the "original" issue if the current issue is a variant).

Instance Attribute Details

#characters ⇒ Harkness::CharacterList (readonly)

Returns a resource list containing the characters which appear in this comic.

Returns:

• (Harkness::CharacterList) —

  a resource list containing the characters which appear in this comic.

# File 'lib/harkness/models/comic.rb', line 111

attribute :characters, Harkness::CharacterList

#collectedIssues ⇒ Array<Harkness::ComicSummary> (readonly)

Returns a list of issues collected in this comic (will generally be empty for periodical formats such as "comic" or "magazine").

Returns:

• (Array<Harkness::ComicSummary>) —

  a list of issues collected in this comic (will generally be empty for periodical formats such as "comic" or "magazine").

# File 'lib/harkness/models/comic.rb', line 93

attribute :collectedIssues, Harkness::ComicSummary, collection: true

#collections ⇒ Array<Harkness::ComicSummary> (readonly)

Returns A list of collections which include this comic (will generally be empty if the comic's format is a collection).

Returns:

• (Array<Harkness::ComicSummary>) —

  A list of collections which include this comic (will generally be empty if the comic's format is a collection).

# File 'lib/harkness/models/comic.rb', line 89

attribute :collections, Harkness::ComicSummary, collection: true

#creators ⇒ Harkness::CreatorList (readonly)

Returns a resource list containing the creators associated with this comic.

Returns:

• (Harkness::CreatorList) —

  a resource list containing the creators associated with this comic.

# File 'lib/harkness/models/comic.rb', line 108

attribute :creators, Harkness::CreatorList

#dates ⇒ Array<Harkness::ComicDate] a list of key dates for this comic. (readonly)

Returns Array<Harkness::ComicDate] a list of key dates for this comic.

Returns:

• (Array<Harkness::ComicDate] a list of key dates for this comic.) —

  Array<Harkness::ComicDate] a list of key dates for this comic.

# File 'lib/harkness/models/comic.rb', line 96

attribute :dates, Harkness::ComicDate, collection: true

#description ⇒ String (readonly)

Returns the preferred description of the comic.

Returns:

• (String) —

  the preferred description of the comic.

# File 'lib/harkness/models/comic.rb', line 45

attribute :description, Shale::Type::String

#diamondCode ⇒ String (readonly)

Returns the Diamond code for the comic.

Returns:

• (String) —

  the Diamond code for the comic.

# File 'lib/harkness/models/comic.rb', line 57

attribute :diamondCode, Shale::Type::String

#digitalId ⇒ Integer (readonly)

Returns the ID of the digital comic representation of this comic. Will be 0 if the comic is not available digitally.

Returns:

• (Integer) —

  the ID of the digital comic representation of this comic. Will be 0 if the comic is not available digitally.

# File 'lib/harkness/models/comic.rb', line 32

attribute :digitalId, Shale::Type::Integer

#ean ⇒ String (readonly)

Returns the EAN barcode for the comic.

Returns:

• (String) —

  the EAN barcode for the comic.

# File 'lib/harkness/models/comic.rb', line 60

attribute :ean, Shale::Type::String

#events ⇒ Harkness::EventList (readonly)

Returns a resource list containing the events in which this comic appears.

Returns:

• (Harkness::EventList) —

  a resource list containing the events in which this comic appears.

# File 'lib/harkness/models/comic.rb', line 117

attribute :events, Harkness::EventList

#format ⇒ String (readonly)

Returns the publication format of the comic e.g. comic, hardcover, trade paperback.

Returns:

• (String) —

  the publication format of the comic e.g. comic, hardcover, trade paperback.

# File 'lib/harkness/models/comic.rb', line 66

attribute :format, Shale::Type::String

#id ⇒ Integer (readonly)

Returns the unique ID of the comic resource.

Returns:

• (Integer) —

  the unique ID of the comic resource.

# File 'lib/harkness/models/comic.rb', line 28

attribute :id, Shale::Type::Integer

#images ⇒ Array<Harkness::Image> (readonly)

Returns a list of promotional images associated with this comic.

Returns:

• (Array<Harkness::Image>) —

  a list of promotional images associated with this comic.

# File 'lib/harkness/models/comic.rb', line 105

attribute :images, Harkness::Image, collection: true

#isbn ⇒ String (readonly)

Returns the ISBN for the comic (generally only populated for collection formats).

Returns:

• (String) —

  the ISBN for the comic (generally only populated for collection formats).

# File 'lib/harkness/models/comic.rb', line 51

attribute :isbn, Shale::Type::String

#issn ⇒ String (readonly)

Returns the ISSN barcode for the comic.

Returns:

• (String) —

  the ISSN barcode for the comic.

# File 'lib/harkness/models/comic.rb', line 63

attribute :issn, Shale::Type::String

#issueNumber ⇒ Integer (readonly)

Returns the number of the issue in the series (will generally be 0 for collection formats).

Returns:

• (Integer) —

  the number of the issue in the series (will generally be 0 for collection formats).

# File 'lib/harkness/models/comic.rb', line 38

attribute :issueNumber, Shale::Type::Integer

#modified ⇒ String (readonly)

Returns the date the resource was most recently modified.

Returns:

• (String) —

  the date the resource was most recently modified.

# File 'lib/harkness/models/comic.rb', line 48

attribute :modified, Shale::Type::String

#pageCount ⇒ Integer (readonly)

Returns the number of story pages in the comic.

Returns:

• (Integer) —

  the number of story pages in the comic.

# File 'lib/harkness/models/comic.rb', line 69

attribute :pageCount, Shale::Type::Integer

#prices ⇒ Array<Harkness::ComicPrice> (readonly)

Returns a list of prices for this comic.

Returns:

• (Array<Harkness::ComicPrice>) —

  a list of prices for this comic.

# File 'lib/harkness/models/comic.rb', line 99

attribute :prices, Harkness::ComicPrice, collection: true

#resourceURI ⇒ String (readonly)

Returns the canonical URL identifier for this resource.

Returns:

• (String) —

  the canonical URL identifier for this resource.

# File 'lib/harkness/models/comic.rb', line 75

attribute :resourceURI, Shale::Type::String

#series ⇒ Array<Harkness::SeriesSummary> (readonly)

Returns a summary representation of the series to which this comic belongs.

Returns:

• (Array<Harkness::SeriesSummary>) —

  a summary representation of the series to which this comic belongs.

# File 'lib/harkness/models/comic.rb', line 81

attribute :series, Harkness::SeriesSummary

#stories ⇒ Harkness::StoryList (readonly)

Returns a resource list containing the stories which appear in this comic.

Returns:

• (Harkness::StoryList) —

  a resource list containing the stories which appear in this comic.

# File 'lib/harkness/models/comic.rb', line 114

attribute :stories, Harkness::StoryList

#textObjects ⇒ Array<Harkness::TextObject> (readonly)

Returns a set of descriptive text blurbs for the comic.

Returns:

• (Array<Harkness::TextObject>) —

  a set of descriptive text blurbs for the comic.

# File 'lib/harkness/models/comic.rb', line 72

attribute :textObjects, Harkness::TextObject, collection: true

#thumbnail ⇒ Harkness::Image (readonly)

Returns the representative image for this comic.

Returns:

• (Harkness::Image) —

  the representative image for this comic.

# File 'lib/harkness/models/comic.rb', line 102

attribute :thumbnail, Harkness::Image

#title ⇒ String (readonly)

Returns the canonical title of the comic.

Returns:

• (String) —

  the canonical title of the comic.

# File 'lib/harkness/models/comic.rb', line 35

attribute :title, Shale::Type::String

#upc ⇒ String (readonly)

Returns the UPC barcode number for the comic (generally only populated for periodical formats).

Returns:

• (String) —

  the UPC barcode number for the comic (generally only populated for periodical formats).

# File 'lib/harkness/models/comic.rb', line 54

attribute :upc, Shale::Type::String

#urls ⇒ Array<Harkness::URL> (readonly)

Returns a set of public web site URLs for the resource.

Returns:

• (Array<Harkness::URL>) —

  a set of public web site URLs for the resource.

# File 'lib/harkness/models/comic.rb', line 78

attribute :urls, Harkness::URL, collection: true

#variantDescription ⇒ String (readonly)

Returns If the issue is a variant (e.g. an alternate cover, second printing, or director’s cut), a text description of the variant.

Returns:

• (String) —

  If the issue is a variant (e.g. an alternate cover, second printing, or director’s cut), a text description of the variant.

# File 'lib/harkness/models/comic.rb', line 42

attribute :variantDescription, Shale::Type::String

#variants ⇒ Array<Harkness::ComicSummary> (readonly)

Returns a list of variant issues for this comic (includes the "original" issue if the current issue is a variant).

Returns:

• (Array<Harkness::ComicSummary>) —

  a list of variant issues for this comic (includes the "original" issue if the current issue is a variant).

# File 'lib/harkness/models/comic.rb', line 85

attribute :variants, Harkness::ComicSummary, collection: true