Class: Aspire::Object::Digitisation

Inherits:
Base
  • Object
show all
Defined in:
lib/aspire/object/digitisation.rb

Overview

Represents a digitisation record in the Aspire API

Constant Summary

Constants inherited from Base

Base::STRIP_HTML

Constants included from Util

Util::LD_API_URI

Instance Attribute Summary collapse

Attributes inherited from Base

#factory, #uri

Instance Method Summary collapse

Methods inherited from Base

#get_boolean, #get_date, #get_property

Methods included from Util

#child_url?, #duration, #id_from_uri, #item?, #linked_data, #linked_data_path, #list?, #list_url?, #module?, #parent_url?, #parse_url, #resource?, #section?, #url_for_comparison, #url_path, #user?

Constructor Details

#initialize(json: nil, ld: nil) ⇒ void

Initialises a new Digitisation instance

Parameters:

  • json (Hash) (defaults to: nil) —

    the parsed JSON data from the JSON API

  • ld (Hash) (defaults to: nil) —

    the parsed JSON data from the linked data API



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/aspire/object/digitisation.rb', line 23

def initialize(json: nil, ld: nil)
  if json
    self.bundle_id = json['bundleId']
    self.request_id = json['requestId']
    self.request_status = json['requestStatus']
  else
    self.bundle_id = nil
    self.request_id = nil
    self.request_status = nil
  end
end

Instance Attribute Details

#bundle_id ⇒ String

Returns the digitisation bundle ID.

Returns:

  • (String) —

    the digitisation bundle ID



9
10
11
 
# File 'lib/aspire/object/digitisation.rb', line 9

def bundle_id
  @bundle_id
end

#request_id ⇒ String

Returns the digitisation request ID.

Returns:

  • (String) —

    the digitisation request ID



13
14
15
 
# File 'lib/aspire/object/digitisation.rb', line 13

def request_id
  @request_id
end

#request_status ⇒ String

Returns the digitisation request status.

Returns:

  • (String) —

    the digitisation request status



17
18
19
 
# File 'lib/aspire/object/digitisation.rb', line 17

def request_status
  @request_status
end

Instance Method Details

#to_s ⇒ String

Returns a string representation of the Digitisation instance (the request ID)

Returns:

  • (String) —

    the string representation of the Digitisation instance



38
39
40
 
# File 'lib/aspire/object/digitisation.rb', line 38

def to_s
  request_id.to_s
end